osSuspendTask function
Declaration:
BOOL osSuspendTask(
  HANDLE Handle
);
Parameters:
Handle

A task handle.

Return value:

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

Description:

Function suspends execution of the specified task.

This function may be called before system start, from an interrupt or by a task. When task suspends itself, or current task is suspended from an interrupt, the scheduler will run ready task with the highest priority. This function is developed to use by a task, to suspend itself execution for further resume by an interrupt. It gives the fastest communication between interrupt and a task. This function will fail, when it is used on waiting task.

Function is available only, when the value of OS_SUSP_RES_TASK_FUNC constant is set to 1. When function is not used, it may be disabled to reduce the output code.

Version:1.0
Header file:OS_Task.h (include OS_API.h)
See also: BOOL, FALSE, HANDLE, OS_SUSP_RES_TASK_FUNC, OS_RESUME_IMMEDIATELY, osGetLastError, osSuspendTask, tasks, task suspending and resuming, TRUE
SpaceShadow documentation