# RTC_GetAlarmParamAsync

## C Specification

  `#include <nitro/rtc.h>`

      RTCResult RTC_GetAlarmParamAsync(
                  RTCAlarmChan        chan,
                  RTCAlarmParam* param
                  RTCCallback         Callback,
                  void*               arg );

## Description

This function asynchronously reads the alarm interrupt parameter values from the real time clock. It queries ARM7 for the values of the alarm interrupt parameters and returns those values without waiting for a response from the processor.

To get the result from the processor, you must use the `result` argument.

If this function fails, no operation is performed and no user callback function is called.

## Arguments

`chan` | Uses the `RTCAlarmChan` to specify the alarm channel.
`param` | Pointer to `RTCAlarmParam` which receives the alarm parameter values.
`callback` | Pointer to `RTCCallback` function to be used.
`arg` | Argument to be passed 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_GetAlarmParamAsync, RTC_SetAlarmParam, RTC_SetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam, RTCCallback`

## Revision History

05/18/2004 Initial Version