# OS_CreateAlarm

## C Specification

      #include <nitro/os.h>

      void OS_CreateAlarm( OSAlarm*  alarm );

## Description

Initializes the alarm structure

One alarm can be set per alarm structure.

Initialize the alarm structure with this function before using it for the first time.

Example:

    OSAlarm alarm;

    OS_CreateAlarm( &alarm );
    OS_SetAlarm( &alarm, count, callback, arg );

Before calling `OS_CreateAlarm()`, the alarm library must be initialized with `OS_InitAlarm()`

## Arguments

`alarm` | Pointer to the alarm structure to initialize

## Return Values

None

## See Also

`OS_InitAlarm, OS_SetAlarm`

## Revision History

02/04/2004 Initial Version