1.2.11.4.22 SYS_TIME_TimerStop Function
C
SYS_TIME_RESULT SYS_TIME_TimerStop ( SYS_TIME_HANDLE handle )
Summary
Stops a running software timer.
Description
This function stops a previously created and running software timer (i.e. the given timer's counter will stop incrementing).
Precondition
The SYS_TIME_Initialize must have been called and a valid handle to the software timer to be stopped must be available.
Parameters
| Param | Description |
|---|---|
| handle | Handle to a software timer instance. |
Returns
SYS_TIME_SUCCESS if the operation succeeds.
SYS_TIME_ERROR if the operation fails (due, for example, to an to an invalid handle).
Example
Given a "timer" handle, the following example will stops the timer's counter running.
SYS_TIME_TimerStop(timer);
Remarks
Calling SYS_TIME_TimerStop on a timer that is not running will have no affect and will return SYS_TIME_SUCCESS.