1.41.17.3 RTC_CallbackRegister Function
C
void RTC_CallbackRegister( RTC_CALLBACK callback, uintptr_t context )
Summary
Sets the pointer to the function (and it's context) to be called when the Timeout events occur.
Description
This function sets the pointer to a client function to be called "back" when the Alarm occurs, It also passes a context value that is passed into the function when it is called. This function is available only in interrupt mode of operation.
Precondition
None.
Parameters
Param | Description |
---|---|
callback | A pointer to a function with a calling signature defined by the RTC_CALLBACK data type |
context | A value (usually a pointer) passed (unused) into the function identified by the callback parameter |
Returns
None.
Example
RTC_CallbackRegister(MyCallback, &myData);
Remarks
The context value may be set to NULL if it is not required. In this case the value NULL will be passed to the callback function. To disable the callback function, pass a NULL for the callback parameter. See the RTC_CALLBACK type definition for additional information.