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

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