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