KsDefaultAddEventHandler function (ks.h)

Article
02/22/2024

The KsDefaultAddEventHandler function is a default routine to handle event 'add' requests.

Syntax

KSDDKAPI NTSTATUS KsDefaultAddEventHandler(
  [in]      PIRP           Irp,
  [in]      PKSEVENTDATA   EventData,
  [in, out] PKSEVENT_ENTRY EventEntry
);

Parameters

[in] Irp

The event IRP. This contains the object into which the event is inserted.

[in] EventData

A pointer to a KSEVENTDATA structure that describes an event notification method.

[in, out] EventEntry

The event entry that is to be inserted into the object's event list. The object is determined by Irp.

Return value

Returns the success or failure of adding the event into the object's event list.

Remarks

KsDefaultAddEventHandler determines the relevant object from Irp and adds the specified event to the object's event list.

This is functionally equivalent to KsAddEvent (or KsXxxAddEvent, see below) for the object that is associated with Irp. Use KsDefaultAddEventHandler from a minidriver-specified AddEvent handler to insert the event into the object's event list.

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	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	PASSIVE_LEVEL