Click or drag to resize

IMcObjectFireCustomNotify Method

Fires a notify to all Attached notify sinks associated with a given IID.

Namespace:  MediaCy.IQL.ObjectManager
Assembly:  MediaCy.IQL.ObjectManager (in MediaCy.IQL.ObjectManager.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function FireCustomNotify ( 
	pimcobjfirecustomsinkGetsFireToCalls As IMcObjFireCustomSink,
	varISinkIIDD As Object,
	Optional lNotifyCode As Integer = 0
) As Boolean

Parameters

pimcobjfirecustomsinkGetsFireToCalls
Type: MediaCy.IQL.ObjectManagerIMcObjFireCustomSink
[in] A pointer to an McObjFireCustomNotify interface. This is the interface that will get a FireTo call for each notified sink. The IMcObjFireCustomSink.FireTo method will know how to call its piunkSinkToCall argument with the custom notify.
varISinkIIDD
Type: SystemObject
lNotifyCode (Optional)
Type: SystemInt32
[in, optional, defaultvalue(0)] A value passed to the FireTo method.

Return Value

Type: Boolean
TRUE if some IMcObjFireCustomSink::FireTo call returned S_FALSE, and thus the notify loop was aborted early. Otherwise, returns FALSE.
Remarks
MOM_uGetNotifySinkIIDFromVariant is used to get the IID of the sink to call. Then for each Sink interface owner with that IID, the IUnknown* piunkSinkToCall is recovered and a call is made to IMcObjFireCustomSink::FireTo( piunkSinkToCall, long(hObj), hObj->GetOwningIMcObject(), lNotifyCode). If the FireTo call returns S_FALSE, then the notify loop is aborted (that is, no other attached sinks are notified). Attached owner sinks are notified in the order they were attached unless McObjects.SetNotifyOrder has been called. There is less overhead calling FireStandardNotifyToAllSinks than using this method, if the IMcObjStandardNotify will work for you. See AttachNotifySink for an explaination of notify-related issues.
See Also