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