xnu-2422.1.72.tar.gz

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

<h2>thread_resume</h2>
<hr>
<p>
<strong>Function</strong> - Resume a thread.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   thread_resume</strong>
                <strong>(thread_act_t</strong>                     <var>target_thread</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>target_thread</var> 
<dd>
[in thread send right]
The thread to be resumed.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>thread_resume</strong> function decrements the suspend count
for <var>target_thread</var> 
by one.  The thread is resumed if its suspend count goes to zero.
If the suspend 
count is still positive, <strong>thread_resume</strong> must be repeated
until the count reaches 
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_resume.html"><strong>task_resume</strong></a>,
<a href="task_suspend.html"><strong>task_suspend</strong></a>,
<a href="thread_create.html"><strong>thread_create</strong></a>,
<a href="thread_info.html"><strong>thread_info</strong></a>,
<a href="thread_suspend.html"><strong>thread_suspend</strong></a>,
<a href="thread_terminate.html"><strong>thread_terminate</strong></a>.