WDF_REL_TIMEOUT_IN_US function (wdfcore.h)

Article
02/22/2024

[Applies to KMDF and UMDF]

The WDF_REL_TIMEOUT_IN_US function converts a specified number of microseconds to a relative time value.

Syntax

LONGLONG WDF_REL_TIMEOUT_IN_US(
  [in] ULONGLONG Time
);

Parameters

[in] Time

The number of microseconds to convert.

Return value

WDF_REL_TIMEOUT_IN_US returns the relative time value, in system time units (100-nanosecond intervals), that represents the number of microseconds that Time specifies.

Remarks

A relative time is a time value that is relative to the current system time. For example, if a caller passes a relative time value of five microseconds to a function that accepts a time-out value, the function will time out five microseconds after it is called.

Examples

The following code example starts a timer. The framework will call the timer's EvtTimerFunc callback function after one hundred microseconds.

BOOLEAN inTimerQueue;

inTimerQueue = WdfTimerStart(
                             timerHandle,
                             WDF_REL_TIMEOUT_IN_US(100)
                             );

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfcore.h (include Wdf.h)
Library	None
IRQL	Any level

Share via