xref: /xnu-10002.41.9/osfmk/man/thread_set_state.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>thread_set_state</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Set the target thread's user-mode execution state.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   thread_set_state</strong>
8*699cd480SApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
9*699cd480SApple OSS Distributions                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,
10*699cd480SApple OSS Distributions                 <strong>thread_state_t</strong>                       <var>new_state</var>,
11*699cd480SApple OSS Distributions                 <strong>target_thread</strong>                  <var>new_state_count</var><strong>);</strong>
12*699cd480SApple OSS Distributions</pre>
13*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
14*699cd480SApple OSS Distributions<dl>
15*699cd480SApple OSS Distributions<p>
16*699cd480SApple OSS Distributions<dt> <var>target_thread</var>
17*699cd480SApple OSS Distributions<dd>
18*699cd480SApple OSS Distributions[in thread send right]
19*699cd480SApple OSS DistributionsThe thread for which to set the execution state.
20*699cd480SApple OSS DistributionsThe calling thread cannot specify itself.
21*699cd480SApple OSS Distributions<p>
22*699cd480SApple OSS Distributions<dt> <var>flavor</var>
23*699cd480SApple OSS Distributions<dd>
24*699cd480SApple OSS Distributions[in scalar]
25*699cd480SApple OSS DistributionsThe type of state to set.  Valid values correspond to
26*699cd480SApple OSS Distributionssupported machine architecture features.
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS Distributions<dt> <var>new_state</var>
29*699cd480SApple OSS Distributions<dd>
30*699cd480SApple OSS Distributions[pointer to in structure]
31*699cd480SApple OSS DistributionsState information for the specified thread.
32*699cd480SApple OSS Distributions<p>
33*699cd480SApple OSS Distributions<dt> <var>new_state_count</var>
34*699cd480SApple OSS Distributions<dd>
35*699cd480SApple OSS Distributions[in scalar]
36*699cd480SApple OSS DistributionsThe size of the buffer (in natural-sized units).
37*699cd480SApple OSS Distributions</dl>
38*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
39*699cd480SApple OSS Distributions<p>
40*699cd480SApple OSS DistributionsThe <strong>thread_set_state</strong> function sets the execution state
41*699cd480SApple OSS Distributions(for example, the
42*699cd480SApple OSS Distributionsmachine registers) for <var>target_thread</var>.  <var>flavor</var> specifies the type
43*699cd480SApple OSS Distributionsof state to set.
44*699cd480SApple OSS Distributions<p>
45*699cd480SApple OSS DistributionsThe format of the state to set is machine specific; it is defined in
46*699cd480SApple OSS Distributions<strong>mach/thread_status.h</strong>.
47*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
48*699cd480SApple OSS Distributions<p>
49*699cd480SApple OSS DistributionsOnly generic errors apply.
50*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
51*699cd480SApple OSS Distributions<p>
52*699cd480SApple OSS DistributionsFunctions:
53*699cd480SApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
54*699cd480SApple OSS Distributions<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,
55*699cd480SApple OSS Distributions<a href="thread_info.html"><strong>thread_info</strong></a>.
56