xref: /xnu-8019.80.24/osfmk/man/task_suspend.html (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions<h2>task_suspend</h2>
2*a325d9c4SApple OSS Distributions<hr>
3*a325d9c4SApple OSS Distributions<p>
4*a325d9c4SApple OSS Distributions<strong>Function</strong> - Suspend the target task.
5*a325d9c4SApple OSS Distributions<h3>SYNOPSIS</h3>
6*a325d9c4SApple OSS Distributions<pre>
7*a325d9c4SApple OSS Distributions<strong>kern_return_t   task_suspend</strong>
8*a325d9c4SApple OSS Distributions                <strong>(task_t</strong>          <var>task</var><strong>);</strong>
9*a325d9c4SApple OSS Distributions</pre>
10*a325d9c4SApple OSS Distributions<h3>PARAMETERS</h3>
11*a325d9c4SApple OSS Distributions<dl>
12*a325d9c4SApple OSS Distributions<p>
13*a325d9c4SApple OSS Distributions<dt> <var>task</var>
14*a325d9c4SApple OSS Distributions<dd>
15*a325d9c4SApple OSS Distributions[in task send right]
16*a325d9c4SApple OSS DistributionsThe port for the task to be suspended.
17*a325d9c4SApple OSS Distributions</dl>
18*a325d9c4SApple OSS Distributions<h3>DESCRIPTION</h3>
19*a325d9c4SApple OSS Distributions<p>
20*a325d9c4SApple OSS DistributionsThe <strong>task_suspend</strong> function increments the suspend count
21*a325d9c4SApple OSS Distributionsfor task and stops all
22*a325d9c4SApple OSS Distributionsthreads within the task.  As long as the suspend count is positive,
23*a325d9c4SApple OSS Distributionsno newly-created threads can execute.  The function does not return until all
24*a325d9c4SApple OSS Distributionsof the task's threads have been suspended.
25*a325d9c4SApple OSS Distributions<h3>NOTES</h3>
26*a325d9c4SApple OSS Distributions<p>
27*a325d9c4SApple OSS DistributionsTo resume a suspended task and its threads, use <strong>task_resume</strong>.
28*a325d9c4SApple OSS DistributionsIf the suspend
29*a325d9c4SApple OSS Distributionscount is greater than one, <strong>task_resume</strong> must be repeated
30*a325d9c4SApple OSS Distributionsthat number of times.
31*a325d9c4SApple OSS Distributions<h3>RETURN VALUES</h3>
32*a325d9c4SApple OSS Distributions<p>
33*a325d9c4SApple OSS DistributionsOnly generic errors apply.
34*a325d9c4SApple OSS Distributions<h3>RELATED INFORMATION</h3>
35*a325d9c4SApple OSS Distributions<p>
36*a325d9c4SApple OSS DistributionsFunctions:
37*a325d9c4SApple OSS Distributions<a href="task_create.html"><strong>task_create</strong></a>,
38*a325d9c4SApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
39*a325d9c4SApple OSS Distributions<a href="task_resume.html"><strong>task_resume</strong></a>,
40*a325d9c4SApple OSS Distributions<a href="task_terminate.html"><strong>task_terminate</strong></a>,
41*a325d9c4SApple OSS Distributions<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.
42