detachEvent method

Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires.

Syntax

HRESULT retVal = object.detachEvent(event, function);

Parameters

• event [in]
  Type: BSTR

  BSTR that specifies any of the standard DHTML Events.

• function [in]
  Type: object

  Pointer to an IDispatch interface that specifies the function previously set using the IHTMLDocument3::attachEvent method.

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

Behaviors that attach to events using the IHTMLDocument3::attachEvent method must explicitly call the IHTMLDocument3::detachEvent method to stop receiving notifications from the page when the ondetach event fires. Behaviors that attach to events using the PUBLIC:ATTACH element automatically stop receiving notifications when the behavior detaches from the element, and thus do not need to call the IHTMLDocument3::detachEvent method.

See also

Reference

IHTMLDocument3::attachEvent

Conceptual

Introduction to DHTML Behaviors

Using DHTML Behaviors

Using HTML Components to Implement DHTML Behaviors in Script