OS_SetAlarmTag


C Specification

#include <nitro/os.h>

void OS_SetAlarmTag( 
            OSAlarm*    alarm , 
            u32         tag );

Description

Sets an alarm tag

These alarm tags are used by OS_CancelAlarms() to cancel all of the alarms belonging to a specified tag group.

The tag value 0 is reserved by the system and cannot be used or allocated by the user.

Arguments

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

Return Values

None

See Also

OS_InitAlarm, OS_CancelAlarms

Revision History

02/04/2004 Initial Version