xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/processor_set_threads.html b/osfmk/man/processor_set_threads.html
old mode 100755 (executable)
new mode 100644 (file)
index 7bdfb66..0af5f9c
--- a/osfmk/man/processor_set_threads.html
+++ b/osfmk/man/processor_set_threads.html
@@ -1 +1,41 @@
-<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
\ No newline at end of file
+<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>.