osSleep function
Declaration:
BOOL osSleep(
  TIME Time
);
Parameters:
Time

Time, for which a task is suspended.

Return value:

TRUE on success or FALSE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function suspends task execution for a specified amount of time.

Function can be performed only by task. When the time it is set to 0 (or OS_IGNORE), the task will voluntarily yields its execution to another task. All other values define a time after which the task will be resumed. Values other than zero may be specified only, when the OS_USE_WAITING_WITH_TIME_OUT is set to 1. The time is specified in time units. For more information on time units please refer to the system time in the scheduling section.

Version:1.0
Header file:OS_API.h
See also: AR_TIME_IGNORE, BOOL, FALSE, osGetLastError, scheduling, TIME, TRUE
SpaceShadow documentation