xnu-3789.1.32.tar.gz

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

<h2>thread_assign_default</h2>
<hr>
<p>
<strong>Function</strong> - Assign a thread to the default processor set.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   thread_assign_default</strong>
                <strong>(thread_act_t</strong>                            <var>thread</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>thread</var> 
<dd>
[in thread send right]
The thread to be assigned.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>thread_assign_default</strong> function assigns <var>thread</var> to
the default processor set. 
After the assignment is completed, the thread executes only on processors that 
are assigned to that processor set.  Any previous assignment of the thread is
nullified.
<h3>NOTES</h3>
<p>
This variant of <strong>thread_assign</strong> exists because the control
port for the default
processor set is privileged, and therefore not available to most tasks.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="thread_assign.html"><strong>thread_assign</strong></a>,
<a href="thread_get_assignment.html"><strong>thread_get_assignment</strong></a>,
<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
<a href="task_assign.html"><strong>task_assign</strong></a>.