Binds the specified function to an event, so that the function gets called whenever the event fires on the object.
Syntax
HRESULT attachEvent( BSTR event, IDispatch *pDisp, VARIANT_BOOL *pfResult );
Parameters
- event
- [in] BSTR that specifies any of the standard DHTML Events.
- pDisp
- [in] Pointer to an IDispatch interface that specifies the function to call when event fires.
- pfResult
- [out, retval] Pointer to a VARIANT_BOOL that receives one of the following possible values:
VARIANT_TRUE- The function was bound successfully to the event.
VARIANT_FALSE- The function was not bound to the event.
Return Value
Returns S_OK if successful, or an error value otherwise.
Remarks
When event fires on the object, the object's event handler is called before pDisp, the specified function. If you attach multiple functions to the same event on the same object, the functions are called in random order, immediately after the object's event handler is called.
The IHTMLElement2::attachEvent method enables a behavior to handle events that occur on the containing page. This method is not limited, however, to behaviors. You can also define a function on a page that attaches to events fired on the same page.
Behaviors that attach to events using the IHTMLElement2::attachEvent method must explicitly call the IHTMLElement2::detachEvent method to stop receiving notifications from the page when the ondetach event fires.
See Also