OSSetAlarmTag

Syntax

#include <cafe/os.h>

void OSSetAlarmTag(OSAlarm* alarm, u32 tag);

Parameters

alarm Pointer to the alarm to set a tag for.
tag Tag value to set.

Return Values

None.

Description

Sets a tag to an alarm. Each alarm can have one tag. The tag is used to cancel groups of alarms with the OSCancelAlarms function.

Do Not Call From

None.

See Also

OSCancelAlarm
OSCancelAlarms
OSCreateAlarm
OSSetPeriodicAlarm

Revision History

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


CONFIDENTIAL