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