xnu-792.24.17.tar.gz

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

<h2>processor_set_threads</h2>
<hr>
<p>
<strong>Function</strong> - Return a list of pointers to all threads currently assigned to the target processor set.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_set_threads</strong>
		<strong>(processor_set_t</strong>	<var>processor_set</var>,
		<strong>thread_port_array_t</strong>	<var>thread_list</var>,
		<strong>mach_msg_type_number_t*</strong>	<var>thread_count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor_set</var> 
<dd>
[in processor-set-control send right]
A processor set control port for 
which information is desired.
<dt> <var>thread_list</var> 
<dd>
[out pointer to dynamic array of thread send rights]
The returned set of 
ports naming the threads currently assigned to <var>processor_set</var>.
<dt> <var>thread_count</var> 
<dd>
[out scalar]
The number of threads returned in <var>thread_list</var>.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_set_threads</strong> function returns send rights
to the kernel ports for each thread currently assigned to <var>processor_set</var>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_set_tasks.html">processor_set_tasks</a>,
<a href="task_assign.html">task_assign</a>,
<a href="thread_assign.html">thread_assign</a>.