KeInitializeTimer function (wdm.h)

Article
02/22/2024

The KeInitializeTimer routine initializes a timer object.

Syntax

void KeInitializeTimer(
  [out] PKTIMER Timer
);

Parameters

[out] Timer

Pointer to a timer object, for which the caller provides the storage.

Return value

None

Remarks

The timer object is initialized to a not-signaled state.

Storage for a timer object must be resident: in the device extension of a driver-created device object, in the controller extension of a driver-created controller object, or in nonpaged pool allocated by the caller.

KeInitializeTimer can only initialize a notification timer. Use KeInitializeTimerEx to initialize a notification timer or a synchronization timer.

Use KeSetTimer or KeSetTimerEx to define when the timer will expire.

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

Callers of KeInitializeTimer should be running at IRQL = DISPATCH_LEVEL or lower. It is best to initialize timers at IRQL = PASSIVE_LEVEL.

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 (see Remarks section)
DDI compliance rules	HwStorPortProhibitedDDIs(storport), IrqlKeDispatchLte(wdm)