AVStrMiniRemoveEvent routine

An AVStream minidriver's AVStrMiniRemoveEvent routine is called when a client requests to be removed from the notification queue for an event. This routine is optional.

Syntax


PFNKSREMOVEEVENT AVStrMiniRemoveEvent;

VOID AVStrMiniRemoveEvent(
  _In_  PFILE_OBJECT FileObject,
  _In_  struct _KSEVENT_ENTRY *EventEntry
)
{ ... }

Parameters

FileObject [in]

Pointer to the file object for which to remove the event.

EventEntry [in]

Pointer to an AVStream-generated KSEVENT_ENTRY structure.

Return value

AVStrMiniRemoveEvent must return STATUS_SUCCESS.

Remarks

The minidriver specifies this routine's address in the RemoveHandler member of a KSEVENT_ITEM structure. Event Handling in AVStream describes how the minidriver provides this structure to the class driver.

If the minidriver provides AVStrMiniRemoveEvent and either:

  • Does not specify an AddHandler or

  • Specifies an AddHandler that calls KsXxxAddEvent

then the minidriver's AVStrMiniRemoveEvent must call RemoveEntryList with a pointer to the LIST_ENTRY structure in the KSEVENT_ENTRY structure:


&EventEntry -> ListEntry

Otherwise, your AVStrMiniRemoveEvent should reverse the steps taken in the AddHandler.

Requirements

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

See also

KSEVENTDATA
KSEVENT_ENTRY
KSEVENT_ITEM
KSAUTOMATION_TABLE
KsFilterAddEvent
KsPinAddEvent
KsFilterGenerateEvents
KsPinGenerateEvents
AVStrMiniAddEvent

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft