@CHIP-RTOS C Library V2.00 - RTOS API
RTX_Install_Timer
Install a timer callback procedure
that will be periodically executed by the kernel. int RTX_Install_Timer ( const TimerProc_Structure far *TProcPtr ); Parameters
TProcPtr
- Input parameter, pointer to a
TimerProc_Structure
type.
Return Value
- 0 on success else
error code.
Comments
- A timer ID is output to the 16 bit location referenced by
timerID
member
of your TimerProc_Structure
.
Alternate method RTX_Install_TimerP
allows the timer installation to be performed based on direct
parameters.
You must call the RTX_Start_Timer
API function to get the kernel to start calling your new timer procedure.
Important:
Timer procedures are executed on the stack
of the kernel task at a high priority, so they should be as short as
possible. Avoid calling time consuming functions.
See Also
RTOS API
- This library function invokes a RTOS software interrupt.
Refer to this RTOS API function's
documentation
for more details.
This API List
List of C Libraries
@CHIP-RTOS Main Index
End of document
|