INtime SDK Help
knWaitForRtAlarmEvent
Note:   This call is deprecated. You should consider using WaitForRtAlarm instead.

Waits on a low-level alarm for the given time interval, or until the alarm triggers.

BOOLEAN knWaitForRtAlarmEvent(
    KNHANDLE hAlarm        // handle for alarm event
    DWORD    dwKernelTicks // number of system timer ticks to wait for alarm
);

Parameters

hAlarm
Handle for the alarm-event.
dwKernelTicks
Number of system timer ticks which the calling thread must wait for a message before returning. The size of this interval is configurable and its value may be obtained from the SYSINFO structure which is read using CopyRtSystemInfo. The macro US_TO_KTICKS may be used to convert a value in microseconds to a system timer tick count using the information supplied in this structure.

Return Values

TRUE
Function was successful.
FALSE
Function Failed. To determine status, call GetLastRtError.

Requirements

Versions Defined in Include Link to
INtime 3.0 intime/rt/include/rtbase.h rt.h rt.lib
   
See Also