OSCreateAlarm

Syntax

#include <cafe/os.h>

void OSCreateAlarm(OSAlarm* alarm);

Parameters

alarm Pointer to the alarm to initialize.

Return Values

None.

Description

Initializes the structure for the specified alarm. Zeroed-out alarm structures do not have to be initialized using the OSCreateAlarm function. Calling OSCreateAlarm on an alarm that is currently running is a programming error.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

OSSetAlarm
OSSetAlarmTag
OSSetPeriodicAlarm
OSCancelAlarm
OSCancelAlarms

Revision History

2013-05-08 Automated cleanup pass.
2010-08-30 Initial version.


CONFIDENTIAL