# RTC_GetAlarmStatusAsync

## C Specification

  `#include <nitro/rtc.h>`

      RTCResult RTC_GetAlarmStatusAsync(
                  RTCAlarmChan    chan,
                  RTCAlarmStatus*   status );
                  RTCCallback         callback,
                  void*               arg );

## Description

This function asynchronously reads alarm interrupt permission status from the real-time clock. It queries ARM7 for the values of the alarm permission status and returns the results without waiting for a response from the processor.

## Cautions

Values are written to the variable specified by the `status` argument asynchronously with respect to the function. Do not use this variable for anything else until a user callback function confirms the completion of this asynchronous operation.

## Arguments

`chan` | Uses `RTCAlarmChan` to specify the alarm channel.
`status` | Pointer to the `RTCAlarmStatus`.
`callback` | Pointer to callback function.
`void` | Argument to pass to the Callback function.

## Return Values

If the request succeeds, it returns 0.
If the request fails, it returns some numeric value other than 0.

## See Also

`RTC_GetAlarmStatus, RTC_SetAlarmStatus, RTC_SetAlarmStatusAsync, RTCResult, RTCAlarmChan, RTCAlarmStatus, RTCCallback`

## Revision History

05/18/2004 Initial Version