Sets the expiration time and repeat interval on the specified timer.

BOOLEAN RtSetTimer(
    HANDLE hTimer,
    PLARGE_INTEGER pExpiration,
    PLARGE_INTEGER pInterval
);

Parameters

hTimer

Handle to the timer object, returned by RtCreateTimer.

pExpiration

Pointer to a LARGE_INTEGER structure that contains the absolute time for the initial expiration, in 100ns units. If this value is negative, the absolute value is interpreted as relative to the current time on the clock; the result is then the same as calling RtSetTimerRelative with the absolute value.

Although time is in 100ns units, the implementation uses the INtime system timer tick (default 500us).

The actual number of INtime ticks the thread waits is calculated as follows:

interval = (parameter + ktick_in_100ns - 1) / ktick_in_100ns;

where: interval is the actual interval slept, ktick_in_100ns is the INtime low-level clock period expressed as a multiple of 100ns, and parameter is the value of the parameter passed.

pInterval

Pointer to a LARGE_INTEGER structure that contains the number of 100ns units between successive expirations.

Remarks

RtSetTimer sets the first expiration time and repeat interval for the timer. If the interval pointer is NULL or if it points to a LARGE_INTEGER value of zero, the timer expires only once.

Each time the timer expires, its handler function executes.

The value in 100ns units rounds to the system timer period.

A timer can be set only when not active; it must be an already expired, one-shot timer or a timer stopped by calling RtCancelTimer.

Return Values

Non-zero

Success.

0 (zero)

Failure. For extended error information, see GetLastError.

Requirements

Note

This function operates in the real-time portion of your application.