IEventManager::DiscardEvents

Description

Discards all pending occurrences of the specified event types for the mechanisms specified in a given session. The information about all the event occurrences that have not yet been handled is discarded. This function is useful to remove event occurrences that an application no longer needs.

VB Prototype

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

C++ Prototype

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

Parameters

type

[Optional in Visual Basic] The type of event to discard.

mech

[Optional in Visual Basic] The mechanism type for the event to discard

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