Edit

Share via

IKsControl::KsEvent method (ks.h)

  • Article

The IKsControl::KsEvent method enables or disables an event, together with any other defined support operations available on an event set.

Syntax

NTSTATUS KsEvent(
  PKSEVENT Event,
  ULONG    EventLength,
  PVOID    EventData,
  ULONG    DataLength,
  ULONG    *BytesReturned
);

Parameters

Event

Pointer to a KSEVENT structure that describes an event to enable the event and NULL to disable the event.

EventLength

Specifies size, in bytes, of the buffer at Event when the event is enabled and zero when the event is disabled.

EventData

Pointer to a KSEVENTDATA structure that contains data for the event and buffer space that receives data for the event.

DataLength

Specifies size, in bytes, of the buffer at EventData.

BytesReturned

Pointer to a variable that receives the size, in bytes, of the data that KsEvent stores in the buffer at EventData.

Return value

The IKsControl::KsEvent method returns the same value that would be returned if the event had been sent by IOCTL.

Remarks

To disable an event, set Event to NULL, EventLength to zero, and EventData to the pointer to the KSEVENTDATA structure that was previously used to enable the event.

Requirements

Requirement Value
Target Platform DesktopMobile
Header ks.h (include Ks.h)

See also

KSEVENT

KSEVENTDATA