osOpenTimer function
Declaration:
HANDLE osOpenTimer(
  SYSNAME Name
);
Parameters:
Name

Name of the timer object.

Return value:

The return value is a handle to the opened timer object when success or NULL_HANDLE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function opens existing timer object.

Timer objects provide methods for synchronization of tasks in reference to the specific time points or time intervals. Timers are similar to events. They are set into signaled state every time when a specified amount of time elapses and into non-signaled when timers are reset.

During timer creation, an optional timer name may be specified. It makes tasks able to open it by osOpenTimer function. The non-used timer should be closed with the osCloseHandle. Timer will be deleted when it is closed by all tasks that opened it. More information you can find in the system objects managementsection.

If all of the osOpen* functions are not used, the system ignores an object name and the code used to name management will be removed. It will reduce final size of the output code. For more information about the names and object opening see the system objects managementsection.

For more information on timers, please refer to the timer objectssection.

Function is available only, when the value of OS_USE_TIMER and OS_OPEN_TIMER_FUNC constants are set to 1. If function is not used, set the OS_OPEN_TIMER_FUNC to 0 to reduce the output code.

Version:1.0
Header file:OS_Timer.h (include OS_API.h)
See also: HANDLE, NULL_HANDLE, OS_OPEN_TIMER_FUNC, osCloseHandle, osCreateTimer, osGetLastError, SYSNAME, system objects management, timers
SpaceShadow documentation