PFNKSREMOVEEVENT callback function (ks.h)

Article
02/22/2024

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 Pfnksremoveevent;

void Pfnksremoveevent(
  [in] PFILE_OBJECT FileObject,
  [in] _KSEVENT_ENTRY *EventEntry
)
{...}

Parameters

[in] FileObject

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

[in] EventEntry

Pointer to an AVStream-generated KSEVENT_ENTRY structure.

Return value

None

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

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform	Desktop
Header	ks.h (include Ks.h)