Cicode Programming Reference > Cicode Function Categories > Task Functions Introduction > TaskSuspend

TaskSuspend

Suspends a task. The task will stop running and will start again only when TaskResume() is called.

Syntax

TaskSuspend(hTask)

hTask:

The task handle, returned from the TaskNew() or TaskHnd() function. The task handle identifies the table where all data on the associated task is stored.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

TaskHnd, TaskKill, TaskNew, TaskResume

Example

TaskSuspend(hTask);
... TaskResume(hTask);

See Also

Task Functions