[apple/xnu.git] / osfmk / man / task_suspend.html

<h2>task_suspend</h2>\r<hr>\r<p>\r<strong>Function</strong> - Suspend the target task.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_suspend</strong>\r                <strong>(task_t</strong>          <var>task</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task to be suspended.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_suspend</strong> function increments the suspend count\rfor task and stops all \rthreads within the task.  As long as the suspend count is positive, \rno newly-created threads can execute.  The function does not return until all \rof the task's threads have been suspended.\r<h3>NOTES</h3>\r<p>\rTo resume a suspended task and its threads, use <strong>task_resume</strong>.\rIf the suspend \rcount is greater than one, <strong>task_resume</strong> must be repeated\rthat number of times.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_create.html"><strong>task_create</strong></a>,\r<a href="task_info.html"><strong>task_info</strong></a>,\r<a href="task_resume.html"><strong>task_resume</strong></a>,\r<a href="task_terminate.html"><strong>task_terminate</strong></a>,\r<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.\r