Classes Class ActiveXObject() :unsubscribeEvent()

Method ActiveXObject():unsubscribeEvent() Foundation

Unubscribe from a COM/ActiveX event.

Syntax 
:unsubscribeEvent( <nDISPID> ) --> lSuccess
Parameters
<nDISPID>
<nDISPID> contains the numeric dispatch ID (DISPID) of the event to unsubscribe from.
Return

:unsubscribeEvent() returns a logical value. If the event identified by the dispatch ID (DISPID) passed in <nDISPID> is unsubscribed, the value .T. (true) is returned. Otherwise, :unsubscribeEvent()returns .F. (false).

Description

The method :unsubscribeEvent() removes a subscription to a COM/ActiveX event established by method :subscribeEvent(). After an event is unsubscribed, the code block passed to :subscribeEvent()is no longer called when the event is fired.

The method :unsubscribeEvent() is used internally by the event handling mechanism introduced by class ActiveXObject. Xbase++ applications need not call this method directly.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.