VideoPortReadStateEvent function (video.h)

The VideoPortReadStateEvent function returns the current state of a given event object: signaled or nonsignaled.

Syntax

VIDEOPORT_API LONG VideoPortReadStateEvent(
  [in] IN PVOID  HwDeviceExtension,
  [in] IN PEVENT pEvent
);

Parameters

[in] HwDeviceExtension

Pointer to the miniport driver's device extension.

[in] pEvent

Pointer to the event object whose state is to be read.

Return value

VideoPortReadStateEvent returns a nonzero value if the event object is currently in the signaled state. If the event object is in the nonsignaled state, this function returns zero.

Remarks

This function is available in Windows XP and later.

Requirements

Requirement Value
Minimum supported client Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform Desktop
Header video.h (include Video.h)
Library Videoprt.lib
DLL Videoprt.sys
IRQL <= DISPATCH_LEVEL