RtSleepFtEx

RtSleepFtEx suspends execution of the current thread for a specified time period.

Syntax

ULONG RtSleepFtEx(
    PLARGE_INTEGER pSleepTime,
    BOOL bAlertable
);

Parameters

pSleepTime

A pointer to the time interval for which execution is to be suspended, in 100-nanosecond units. If this value is 0, the thread relinquishes the remainder of its time slice to any other thread of equal priority that is ready to run. If there are no other threads of equal priority ready to run, the function returns immediately, and the thread continues execution.

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.

bAlertable

This parameter is ignored. This function does not return until the sleep period specified in parameter pSleepTime has elapsed.

Return Value

This function returns 0 if successful and -1 if it fails. If this function fails, call GetLastError to obtain an error code.

Remarks

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