Click or drag to resize

IMcObjectFireStandardNotifyToAllSinks Method

A notify is fired to all standard (IID_IMcObjStandardNotify) sink interfaces currently attached to the object.

Namespace:  MediaCy.IQL.ObjectManager
Assembly:  MediaCy.IQL.ObjectManager (in MediaCy.IQL.ObjectManager.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function FireStandardNotifyToAllSinks ( 
	Optional lNotifyCode As Integer = 0,
	<OptionalAttribute> varNotifyData As Object
) As Boolean

Parameters

lNotifyCode (Optional)
Type: SystemInt32
If zero, an IStandardNotify::ValueChanged call is made to all sinks and the varNotifyData argument is ignored. If non-zero, an IStandardNotify::SpecialNotify(pmcObj,lNofifyCode, varNotifyData) call is made to all sinks.
varNotifyData (Optional)
Type: SystemObject
Any data to be passed along with a non-zero lNotifyCode in each IStandardNotify::SpecialNotify call.

Return Value

Type: Boolean
TRUE if a SpecialNotify aborted the notify loop by returning S_FALSE. Otherwise returns FALSE.
Remarks
The notify fired may be either an IStandardNotify::ValueChanged call or an McObjStandardNotify::SpecialNotify, depending on whether the lNotifyCode argument is zero or not. A SpecialNotify sink (lNotifyCode non-zero), may abort the notification loop by returning S_FALSE. This will prevent any remaining attached sinks from receiving the notifcation. Attached owner sinks are notified in the order they were attached unless McObjects.SetNotifyOrder has been called. See AttachNotifySink for an explaination of notify-related issues.
See Also