RtSleepFt

RtSleepFt suspends the current thread for the specified time with the granularity of the RTSS timer.

Syntax

VOID RtSleepFt(
    PLARGE_INTEGER pSleepTime);

Parameters

pSleepTime

A pointer to a LARGE_INTEGER structure indicating the amount of time to sleep, in 100ns units. pSleepTime must be less than or equal to one second, and must be greater than or equal to the minimum timer period of the system. To retrieve the HAL timer period, call RtGetClockTimerPeriod with a clock value of CLOCK_2.

Return Value

This function returns no value.

Remarks

RtSleepFt suspends the given thread from execution for the specified amount of time.

An expiration interval of 0 yields the process to other equal priority runnable threads (if any).

NOTE: The RtSleepFt function can return within one HAL timer tick early of the requested time. For example, if the HAL timer is set at 20µs, RtSleepFt can return up to 20µs earlier than the requested time.

NOTE: This function can only be called from an RTSS process or RTDLL.

See Also:

• RtCreateTimer
• RtDeleteTimer
• RtGetClockResolution
• RtGetClockTime
• RtGetClockTimerPeriod
• RtGetTimer
• RtSetClockTime
• RtSetTimer
• RtSetTimerRelative
• Sleep
• Application timer expiration behavior