Click or drag to resize

IMcObjectsSetNotifyOrder Method

Sets the notify order for some sink for one or all objects.

Namespace:  MediaCy.IQL.ObjectManager
Assembly:  MediaCy.IQL.ObjectManager (in MediaCy.IQL.ObjectManager.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Sub SetNotifyOrder ( 
	ckhCookie As IntPtr,
	<OptionalAttribute> varMcObjectToSetOrderFor As Object,
	Optional lNotifyOrderIndex As Integer = 0
)

Parameters

ckhCookie
Type: SystemIntPtr
[in] The "cookie" value returned from a previous call to AttachNotifySinkToCategory, AttachNotifySinkToType or McObject.AttachNotifySink. The "cookie" will be the same for all AttachNotify... calls sharing the same notify sink interface instance (the
varMcObjectToSetOrderFor (Optional)
Type: SystemObject
[in, optional] If missing, VT_EMPTY, VT_ERROR or VT_NULL, then the notify order is set for all McObject instances to which the ckhCookie was attached. Otherwise it must be an McObject instance for which the order is being set.
lNotifyOrderIndex (Optional)
Type: SystemInt32
[in, defaultvalue(0)] The notify order index. Zero, the default, is the first. Any negative number implies that the order is being set to be the last.
Remarks
The order in which a given attached sink interface is notified is specified as an index value (0, the first to be notified is the default). The order may be set for a specified McObject instance or for all McObject's for which the sink is a notify client. Without reordering, when a notify is fired from some McObject (see FireStandardNotifyToAllSinks and FireCustomNotify), notify sink interfaces are called in the order that they were attached to the McObject instance. All sink interfaces attached due to AttachNotifySinkToType will be first (they will be attached as soon as the object is created by the Add method). All sink interfaces attached due to AttachNotifySinkToCategory will be attached as notify sinks whenever the McObject is added to the category (either at Add time or when the McObject.Category property is assigned to). Notify order can be especially important when some interface wants to be able to abort the notify to any other sinks. Such an abort is possible for FireStandardNotifyToAllSinks calls to IMcObjStandardNofiy::SpecialNotify and for any FireCustomNotify IMcObjFireCustomSink implementation that is set up to return S_FALSE from the IMcObjFireCustomSink::FireTo method.
See Also