Edit

KeReadStateTimer function (wdm.h)

  • Article

The KeReadStateTimer routine reads the current state of a timer object.

Syntax

BOOLEAN KeReadStateTimer(
  [in] PKTIMER Timer
);

Parameters

[in] Timer

A pointer to an initialized timer object, for which the caller provides the storage.

Return value

KeReadStateTimer returns TRUE if the current state of the timer object is signaled; otherwise, it returns FALSE.

Remarks

This routine provides an efficient way to poll the signal state of a timer. KeReadStateTimer reads the state of the timer without synchronizing its access to the timer. Do not assume that accesses of a timer state by KeReadStateTimer are mutually exclusive of accesses by routines, such as KeSetTimer and KeWaitForSingleObject, that do synchronize their access to the timer state.

For more information about timer objects, see Timer Objects and DPCs.

Requirements

Requirement Value
Minimum supported client Available starting with Windows 2000.
Target Platform Universal
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL <= DISPATCH_LEVEL
DDI compliance rules HwStorPortProhibitedDDIs(storport), IrqlKeDispatchLte(wdm)

See also

KTIMER

KeCancelTimer

KeInitializeTimer

KeSetTimer

KeWaitForSingleObject