BOOL osSleep( TIME Time );
The duration for which the task will be suspended.
Returns TRUE on success or FALSE on failure. Call the osGetLastError function to obtain extended error information.
This function suspends the execution of the current task for a specified duration.
The function can only be called from within a task context. When the time parameter is set to 0 (or OS_IGNORE), the task voluntarily yields its remaining time slice to another task. All other values specify a duration after which the task will be resumed. Values greater than zero may only be used when OS_USE_WAITING_WITH_TIME_OUT is set to 1. The duration is specified in system time units. For more information regarding time units, please refer to the system time description in the scheduling section.
| Version: | 1.0 |
|---|---|
| Header file: | OS_API.h |
| See also: | AR_TIME_IGNORE, BOOL, FALSE, osGetLastError, scheduling, TIME, TRUE |
- About SpaceShadow products
- Architecture dependencies
- Standard Library
- Operating System Kernel
- Real-time performance
- Scheduling
- Synchronization
- Interprocess communication
- Interrupts
- System objects management
- System objects
- Using the operating system
- Examples
- Constants
- Configuration
- OS_ALLOW_OBJECT_DELETION
- OS_FIX_POOL0_ITEM_SIZE
- OS_FIX_POOL0_SIZE
- OS_FIX_POOL1_ITEM_SIZE
- OS_FIX_POOL1_SIZE
- OS_FIX_POOL2_ITEM_SIZE
- OS_FIX_POOL2_SIZE
- OS_FIX_POOL3_ITEM_SIZE
- OS_FIX_POOL3_SIZE
- OS_DEINIT_FUNC
- OS_GET_SYSTEM_STAT_FUNC
- OS_IDLE_STACK_SIZE
- OS_INTERNAL_MEMORY_SIZE
- OS_LOWEST_USED_PRIORITY
- OS_MAX_WAIT_FOR_OBJECTS
- OS_OPEN_BY_HANDLE_FUNC
- OS_READ_WRITE_FUNC
- OS_RESUME_IMMEDIATELY
- OS_STACK_SIZE
- OS_STAT_SAMPLE_RATE
- OS_STOP_FUNC
- OS_SYS_OBJECT_MAX_NAME_LEN
- OS_USE_FIXMEM_POOLS
- OS_USE_WAITING_WITH_TIME_OUT
- OS_USED
- Functions
- Types