fireEvent method
Fires a specified event on the object.
Syntax
HRESULT retVal = object.fireEvent(bstrEventName, pvarEventObject, pfCancelled);
Parameters
- bstrEventName [in]
-
Type: BSTR
BSTR that specifies the name of the event to fire.
- pvarEventObject [in, optional]
-
Type: VARIANT
Pointer to a VARIANT that specifies the IHTMLEventObj interface from which the event properties are obtained. - pfCancelled [out, retval]
-
Type: VARIANT_BOOL
VARIANT_BOOL that receives one of the following values:
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Standards information
There are no standards that apply here.
Remarks
If the event being fired cannot be canceled, IHTMLDocument4::fireEvent always returns VARIANT_TRUE.
See also
Show: