This documentation is archived and is not being maintained.

ComAwareEventInfo.RemoveEventHandler Method

Detaches an event handler from a COM object.

Namespace:  System.Runtime.InteropServices
Assembly:  System.Core (in System.Core.dll)

public override void RemoveEventHandler(
	Object target,
	Delegate handler
)

Parameters

target
Type: System.Object
The target object that the event delegate is bound to.
handler
Type: System.Delegate
The event delegate.

Implements

_EventInfo.RemoveEventHandler(Object, Delegate)

ExceptionCondition
InvalidOperationException

The event does not have a public remove accessor.

ArgumentException

The handler that was passed in cannot be used.

TargetException

The target parameter is null and the event is not static.

-or-

The EventInfo is not declared on the target.

MethodAccessException

The caller does not have access permission to the member.

This method is similar to the EventInfo.RemoveEventHandler(Object, Delegate) method, except that it allows you to detach events from COM objects.

If target is a COM object, this method releases a delegate to an event by using the ComEventsHelper.Remove(Object, Guid, Int32, Delegate) method.

RemoveEventHandler facilitates unregistering COM event sinks that forward calls to corresponding managed delegates. It requires the following information:

  • The target object itself (target).

  • The GUID of the source interface.

  • The DispID of the method on the COM interface that corresponds to the specified event.

  • The delegate that would be invoked when the COM object triggers the corresponding event (handler).

RemoveEventHandler looks up the corresponding COM source interface (specified as the first parameter of the ComEventInterfaceAttribute.ComEventInterfaceAttribute(Type, Type) constructor). It then it looks up a method on the source interface whose name is identical to the event name. The value of GuidAttribute on the source interface is the GUID that is passed to ComEventsHelper.Remove(Object, Guid, Int32, Delegate); the value of DispIDAttribute on the method is the DispID value that is passed to ComEventsHelper.Remove(Object, Guid, Int32, Delegate).

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: