xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/task_threads.html b/osfmk/man/task_threads.html
old mode 100755 (executable)
new mode 100644 (file)
index 7321c1a..4dec84b
--- a/osfmk/man/task_threads.html
+++ b/osfmk/man/task_threads.html
@@ -1 +1,46 @@
-<h2>task_threads</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the target task's list of threads.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_threads</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>thread_act_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<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task for which the thread list is to \rbe returned.\r<p>\r<dt> <var>thread_list</var> \r<dd>\r[out pointer to dynamic array of thread send rights]\rThe returned list of \rthreads within <var>task</var>, in no particular order.\r<p>\r<dt> <var>thread_count</var> \r<dd>\r[out scalar]\rThe returned count of threads in <var>thread_list</var>.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_threads</strong> function returns a list of the threads\rwithin <var>task</var>.  The calling \rtask or thread also receives a send right to the kernel port\rfor each listed thread.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_create.html"><strong>thread_create</strong></a>,\r<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,\r<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.\r
\ No newline at end of file
+<h2>task_threads</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return the target task's list of threads.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   task_threads</strong>
+                <strong>(task_t</strong>                                    <var>task</var>,
+                 <strong>thread_act_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>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The port for the task for which the thread list is to 
+be returned.
+<p>
+<dt> <var>thread_list</var> 
+<dd>
+[out pointer to dynamic array of thread send rights]
+The returned list of 
+threads within <var>task</var>, in no particular order.
+<p>
+<dt> <var>thread_count</var> 
+<dd>
+[out scalar]
+The returned count of threads in <var>thread_list</var>.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>task_threads</strong> function returns a list of the threads
+within <var>task</var>.  The calling 
+task or thread also receives a send right to the kernel port
+for each listed thread.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="thread_create.html"><strong>thread_create</strong></a>,
+<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,
+<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.