INtime SDK Help
ResetRtAlarm
INtime SDK v7.1 > About INtime > INtime Kernel > Time management > ResetRtAlarm

Resets a one-shot alarm after it has triggered.

BOOLEAN ResetRtAlarm(
    RTHANDLE hAlarm    // handle for alarm event
);

Parameters

hAlarm
Handle for an alarm object.

Remarks

This operation is equivalent to invoking DeleteRtAlarm, then invoking CreateRtAlarm.

Because ResetRtAlarm may be invoked on single-shot alarms even if the alarm has gone off, it is not necessary to synchronize between an alarm reset and the expiration of the alarm time interval. Although this call is non-scheduling, it is not recommended for use by interrupt handlers.

Return Values

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

Status

E_TYPE 0x8002
The hAlarm parameter does not refer to a valid alarm object.

Additional Information

Supersedes the knResetRtAlarmEvent 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