OSSetAlarm

Syntax

#include <revolution/os.h>

typedef void (* OSAlarmHandler ) (OSAlarm* alarm, OSContext* context);

void OSSetAlarm (OSAlarm*       alarm,
                OSTime         tick,
                OSAlarmHandler handler);

Arguments

*`alarm`*	Pointer to alarm to set.
*`tick`*	Tick count before firing.
*`handler`*	Alarm handler to call.

Return Values

None.

Description

Sets a one-time alarm.

Note: If you are going to reset an active alarm that was set by the OSSetPeriodicAlarm function, call the OSCancelAlarm function and delete that alarm before setting it again. Operations are not guaranteed if you reset an alarm without first deleting it.

Revision History

2009/09/24 Added a note about resetting alarms.
2006/03/01 Initial version.