Expand Minimize

KeReadStateTimer routine

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

Syntax


BOOLEAN KeReadStateTimer(
  _In_  PKTIMER Timer
);

Parameters

Timer [in]

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

Version

Available starting with Windows 2000.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

Ntoskrnl.lib

IRQL

<= DISPATCH_LEVEL

DDI compliance rules

IrqlKeDispatchLte, HwStorPortProhibitedDDIs

See also

KeCancelTimer
KeInitializeTimer
KeSetTimer
KeWaitForSingleObject
KTIMER

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft