xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/thread_set_state.html b/osfmk/man/thread_set_state.html
index 3e64d6ca9d765d973b9427c60448de1f92fd07f2..db4172aeb5a986b3c560b71947a5fac2d50f88d8 100755 (executable)
--- a/osfmk/man/thread_set_state.html
+++ b/osfmk/man/thread_set_state.html
@@ -1 +1,55 @@
-<h2>thread_set_state</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set the target thread's user-mode execution state.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   thread_set_state</strong>\r                <strong>(thread_act_t</strong>                     <var>target_thread</var>,\r                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,\r                 <strong>thread_state_t</strong>                       <var>new_state</var>,\r                 <strong>target_thread</strong>                  <var>new_state_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>target_thread</var> \r<dd>\r[in thread send right]\rThe thread for which to set the execution state. \rThe calling thread cannot specify itself.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of state to set.  Valid values correspond to\rsupported machine architecture features.\r<p>\r<dt> <var>new_state</var> \r<dd>\r[pointer to in structure]\rState information for the specified thread.\r<p>\r<dt> <var>new_state_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_set_state</strong> function sets the execution state\r(for example, the\rmachine registers) for <var>target_thread</var>.  <var>flavor</var> specifies the type\rof state to set.\r<p>\rThe format of the state to set is machine specific; it is defined in\r<strong>mach/thread_status.h</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_info.html"><strong>task_info</strong></a>,\r<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,\r<a href="thread_info.html"><strong>thread_info</strong></a>.\r
\ No newline at end of file
+<h2>thread_set_state</h2>
+<hr>
+<p>
+<strong>Function</strong> - Set the target thread's user-mode execution state.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   thread_set_state</strong>
+                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
+                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,
+                 <strong>thread_state_t</strong>                       <var>new_state</var>,
+                 <strong>target_thread</strong>                  <var>new_state_count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>target_thread</var> 
+<dd>
+[in thread send right]
+The thread for which to set the execution state. 
+The calling thread cannot specify itself.
+<p>
+<dt> <var>flavor</var> 
+<dd>
+[in scalar]
+The type of state to set.  Valid values correspond to
+supported machine architecture features.
+<p>
+<dt> <var>new_state</var> 
+<dd>
+[pointer to in structure]
+State information for the specified thread.
+<p>
+<dt> <var>new_state_count</var> 
+<dd>
+[in scalar]
+The size of the buffer (in natural-sized units).
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>thread_set_state</strong> function sets the execution state
+(for example, the
+machine registers) for <var>target_thread</var>.  <var>flavor</var> specifies the type
+of state to set.
+<p>
+The format of the state to set is machine specific; it is defined in
+<strong>mach/thread_status.h</strong>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="task_info.html"><strong>task_info</strong></a>,
+<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,
+<a href="thread_info.html"><strong>thread_info</strong></a>.