xnu-4903.221.2.tar.gz

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

<h2>processor_get_assignment</h2>
<hr>
<p>
<strong>Function</strong> - Get current assignment for a processor.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_get_assignment</strong>
		<strong>(processor_t</strong>	<var>processor</var>,
		<strong>processor_set_name_t</strong>	<var>assigned_set</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor</var> 
<dd>
[in processor send right]
The processor whose assignment is desired.
<dt> <var>new_set</var> 
<dd>
[out processor-set-name send right]
The name port for the processor 
set to which <var>processor</var> is currently assigned.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_get_assignment</strong> function returns the name port for the
processor set to which a desired processor is currently assigned.
<h3>RETURN VALUES</h3>
<dl>
<dt> <strong>KERN_FAILURE</strong>
<dd>
Processor is either shut down of off-line.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_assign.html">processor_assign</a>,
<a href="processor_set_create.html">processor_set_create</a>,
<a href="processor_info.html">processor_info</a>,
<a href="task_assign.html">task_assign</a>,
<a href="thread_assign.html">thread_assign</a>.