IHTMLElement2::attachEvent Method

Binds the specified function to an event, so that the function gets called whenever the event fires on the object.

Syntax

HRESULT attachEvent(
    BSTR sEvent, 
    IDispatch *pDisp
    VARIANT_BOOL *pfResult
);

Parameters

sEvent

String (BSTR) that specifies the name of the event.

pDisp

Address of an IDispatch interface that returns an object to be called whenever sEvent fires.

pfResult

Address of a VARIANT_BOOL that receives one of the following values:

VARIANT_TRUE
Function did bind successfully to the event
VARIANT_FALSE
Function did not bind successfully to the event.

Return Value

Returns S_OK if the function was bound successfully, or an error value otherwise.

Remarks

When sEvent fires on the object, the object's sEvent handler is called first before the specified function, pDisp. If multiple functions are attached to the same event on the same object, the pDisp(s) will be called in a random order, immediately after the object's event handler is called.