KsGenerateEventList function (ks.h)

The KsGenerateEventList function enumerates the event list and searches for the specified event to generate.

Syntax

KSDDKAPI VOID KsGenerateEventList(
  [in, optional] GUID              *Set,
  [in]           ULONG             EventId,
  [in]           PLIST_ENTRY       EventsList,
  [in]           KSEVENTS_LOCKTYPE EventsFlags,
  [in]           PVOID             EventsLock
);

Parameters

[in, optional] Set

Specifies an optional set that the event to be generated belongs to. If present, this value is compared against the set identifier for each event in the list. If not present, the set identifiers are ignored and just the specific event identifier is used in the comparison for matching events on the list. This comparison saves time when all events are known to be contained in a single set.

[in] EventId

Specifies the specific event identifier to look for on the list.

[in] EventsList

Points to the head of the list of KSEVENT_ENTRY items on which the event can be found.

[in] EventsFlags

Specifies the KSEVENTS_LOCKTYPE flag specifying the exclusion lock type to be used in accessing the event list. If no flag is set, then no lock is taken.

[in] EventsLock

Used to synchronize access to an element on the list. The lock is taken before enumerating the list and released after enumeration.

Return value

None

Remarks

This function can be called at any IRQL level if the locking mechanism permits it.

Requirements

Requirement Value
Target Platform Universal
Header ks.h (include Ks.h)
Library Ks.lib
IRQL Any level (See Remarks section)

See also

KsFilterAddEvent

KsFilterGenerateEvents

KsPinAddEvent

KsPinGenerateEvents