OS_SetAlarmTag

Syntax

#include <nitro/os.h>
void OS_SetAlarmTag( OSAlarm* alarm, u32 tag );

Arguments

alarm Pointer to the alarm structure that sets the tag
tag The tag that is set.

Return Values

None.

Description

Sets a tag to an alarm.

These alarm tags are used by OS_CancelAlarms() to cancel all of the alarms belonging to a specified tag group. Values from 1 to 255 can be set for tag. A value of 0 is reserved by the system and cannot be used by applications.

See Also

OS_InitAlarm, OS_CancelAlarms

Revision History

2004/02/04 Initial version.

CONFIDENTIAL