xnu-2422.1.72.tar.gz

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

<h2>task_resume</h2>
<hr>
<p>
<strong>Function</strong> - Decrement the target task's suspend count.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   task_resume</strong>
                <strong>(task_t</strong>         <var>task</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>task</var> 
<dd>
[in task send right]
The port to the task to be resumed.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>task_resume</strong> function decrements the suspend count
for <var>task</var>.  If the task's suspend count goes to zero, the 
function resumes any suspended threads within the task.  To resume 
a given thread, the thread's own suspend count must also be zero.
<h3>NOTES</h3>
<p>
An attempt to lower the suspend count below zero is ignored.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="task_create.html"><strong>task_create</strong></a>,
<a href="task_info.html"><strong>task_info</strong></a>,
<a href="task_suspend.html"><strong>task_suspend</strong></a>,
<a href="task_terminate.html"><strong>task_terminate</strong></a>,
<a href="thread_info.html"><strong>thread_info</strong></a>,
<a href="thread_resume.html"><strong>thread_resume</strong></a>,
<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.