xref: /xnu-11215.41.3/osfmk/man/thread_get_state.html (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions<h2>thread_get_state</h2>
2*33de042dSApple OSS Distributions<hr>
3*33de042dSApple OSS Distributions<p>
4*33de042dSApple OSS Distributions<strong>Function</strong> - Return the execution state for a thread.
5*33de042dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*33de042dSApple OSS Distributions<pre>
7*33de042dSApple OSS Distributions<strong>kern_return_t   thread_get_state</strong>
8*33de042dSApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
9*33de042dSApple OSS Distributions                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,
10*33de042dSApple OSS Distributions                 <strong>thread_state_t</strong>                       <var>old_state</var>,
11*33de042dSApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>         <var>old_state_count</var><strong>);</strong>
12*33de042dSApple OSS Distributions</pre>
13*33de042dSApple OSS Distributions<h3>PARAMETERS</h3>
14*33de042dSApple OSS Distributions<dl>
15*33de042dSApple OSS Distributions<p>
16*33de042dSApple OSS Distributions<dt> <var>target_thread</var>
17*33de042dSApple OSS Distributions<dd>
18*33de042dSApple OSS Distributions[in thread send right]
19*33de042dSApple OSS DistributionsThe thread for which the execution state is to be
20*33de042dSApple OSS Distributionsreturned.  The calling thread cannot specify itself.
21*33de042dSApple OSS Distributions<p>
22*33de042dSApple OSS Distributions<dt> <var>flavor</var>
23*33de042dSApple OSS Distributions<dd>
24*33de042dSApple OSS Distributions[in scalar]
25*33de042dSApple OSS DistributionsThe type of execution state to be returned.  Valid values
26*33de042dSApple OSS Distributionscorrespond to supported machined architectures.
27*33de042dSApple OSS Distributions<p>
28*33de042dSApple OSS Distributions<dt> <var>old_state</var>
29*33de042dSApple OSS Distributions<dd>
30*33de042dSApple OSS Distributions[out structure]
31*33de042dSApple OSS DistributionsState information for the specified thread.
32*33de042dSApple OSS Distributions<p>
33*33de042dSApple OSS Distributions<dt> <var>old_state_count</var>
34*33de042dSApple OSS Distributions<dd>
35*33de042dSApple OSS Distributions[in/out scalar]
36*33de042dSApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
37*33de042dSApple OSS Distributionssize returned (in natural-sized units).
38*33de042dSApple OSS Distributions</dl>
39*33de042dSApple OSS Distributions<h3>DESCRIPTION</h3>
40*33de042dSApple OSS Distributions<p>
41*33de042dSApple OSS DistributionsThe <strong>thread_get_state</strong> function returns the execution
42*33de042dSApple OSS Distributionsstate (for example, the
43*33de042dSApple OSS Distributionsmachine registers) for <var>target_thread</var>. flavor specifies the type
44*33de042dSApple OSS Distributionsof state information
45*33de042dSApple OSS Distributionsreturned.
46*33de042dSApple OSS Distributions<p>
47*33de042dSApple OSS DistributionsThe format of the data returned is machine specific; it is defined in
48*33de042dSApple OSS Distributions\*L<mach/thread_status.h>\*O.
49*33de042dSApple OSS Distributions<h3>RETURN VALUES</h3>
50*33de042dSApple OSS Distributions<p>
51*33de042dSApple OSS DistributionsOnly generic errors apply.
52*33de042dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
53*33de042dSApple OSS Distributions<p>
54*33de042dSApple OSS DistributionsFunctions:
55*33de042dSApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
56*33de042dSApple OSS Distributions<a href="thread_info.html"><strong>thread_info</strong></a>,
57*33de042dSApple OSS Distributions<a href="thread_set_state.html"><strong>thread_set_state</strong></a>.
58