Jump to main content

##

# 1.2.11.4.21 SYS_TIME_TimerStart Function

## C

    SYS_TIME_RESULT SYS_TIME_TimerStart ( SYS_TIME_HANDLE handle )

## Summary

Starts a software timer running.

## Description

This function starts a previously created software timer.

## Precondition

The SYS_TIME_Initialize must have been called and a valid handle to the software timer to be started 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 start the timer's counter running.

    SYS_TIME_TimerStart(timer);

## 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's initial configured timer/counter value and will not resume the timer from the counter value at which it was stopped.