IEventManager::DisableEvent

Description

Disables servicing of an event identified by the eventType parameter for the mechanisms specified in the mechanism parameter. Specifying ALL_ENABLED_EVENTS for the eventType parameter allows a session to stop receiving all events.

The session can stop receiving queued events by specifying EVENT_QUEUE. Applications can stop receiving callback events by specifying either EVENT_HNDLR or EVENT_SUSPEND_HNDLR. Specifying EVENT_ALL_MECH disables both the queuing and callback mechanisms.

VB Prototype

DisableEvent(
  type As EventType, ' Optional Parameter
  mech As EventMechanism, ' Optional Parameter
  customEventType As Long ' Optional Parameter
)

C++ Prototype

HRESULT DisableEvent(
  EventType type,
  EventMechanism mech,
  long customEventType
);

Parameters

type

[Optional in Visual Basic] The type of event to disable

mech

[Optional in Visual Basic] The mechanism type of the event to disable.

customEventType

[Optional in Visual Basic] If the event type property is CUSTOM_EVENT_TYPE, this argument contains the custom event type number, otherwise it is ignored.

Return Value

Refer to the table of return codes.

See Also

ComponentVersion, SpecVersion, HardwareInterfaceName, HardwareInterfaceNumber, HardwareInterfaceType, LockState, OptionString, ProgID, ResourceName, SessionType, SoftwareManufacturerID, SoftwareManufacturerName, Timeout, LastStatus, MaximumQueueLength, GetAttribute, SetAttribute, LockRsrc, UnlockRsrc, Init, Close, EnableEvent, DisableEvent, DiscardEvents, WaitOnEvent, InstallHandler, UninstallHandler, IEventManager Overview