xnu-7195.60.75.tar.gz

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

<h2>thread_get_assignment</h2>
<hr>
<p>
<strong>Function</strong> - Return the processor set to which a thread is assigned.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   thread_get_assignment</strong>
                <strong>(thread_act_t</strong>                            <var>thread</var>,
                 <strong>processor_set_name_t</strong>             <var>processor_set</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>thread</var> 
<dd>
[in thread send right]
The thread whose assignment is desired.
<p>
<dt> <var>processor_set</var> 
<dd>
[out processor-set-name send right]
The name port for the processor 
set into which the thread is assigned.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>thread_get_assignment</strong> function returns the name
port to the processor set to which <var>thread</var> is currently assigned.  
This port can only be used to obtain information about the processor set.
<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_assign_default.html"><strong>thread_assign_default</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>.