1.2.11.4.21 SYS_TIME_TimerStart Function

1.2.11.4.21 C

SYS_TIME_RESULT SYS_TIME_TimerStart ( SYS_TIME_HANDLE handle )

1.2.11.4.21 Summary

Starts a software timer running.

1.2.11.4.21 Description

This function starts a previously created software timer.

1.2.11.4.21 Precondition

The SYS_TIME_Initialize must have been called and a valid handle to the software timer to be started must be available.

1.2.11.4.21 Parameters

ParametersDescription
handleHandle to a software timer instance

1.2.11.4.21 Returns

SYS_TIME_SUCCESS if the operation succeeds.

SYS_TIME_ERROR if the operation fails (due, for example, to an invalid handle).

1.2.11.4.21 Example

Given a "timer" handle, the following example will start the timer's counter running.

SYS_TIME_TimerStart(timer);

1.2.11.4.21 Remarks

Calling SYS_TIME_TimerStart on an already running timer will have no affect and will return SYS_TIME_SUCCESS.

Calling SYS_TIME_TimerStart on a timer that is stopped, will always restart the timer from it is initial configured timer/counter value and will not resume the timer from the counter value at which it was stopped.