INtime SDK Help
DeleteRtAlarm
INtime SDK v6 > About INtime > INtime Kernel > Time management > DeleteRtAlarm

Deletes the alarm object associated with the given kernel handle. All threads waiting at the alarm object are awakened and given an E_EXIST status.    

BOOLEAN DeleteRtAlarm(
    RTHANDLE hAlarm    // kernel handle for alarm
);

Parameters

hAlarm
Handle for the alarm to delete.

Returns

On success returns TRUE, otherwise returns FALSE if the hAlarm parameter is not a valid hanlde for an alarm object.

Additional Information

Supersedes the knDeleteRtAlarmEvent call, which is deprecated.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/rtbase.h rt.h rt.lib

See Also

Time management system calls, E_EXIST

Send Feedback