xref: /xnu-11215.61.5/osfmk/man/clock_get_attributes.html (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions<h2>clock_get_attributes</h2>
2*4f1223e8SApple OSS Distributions<hr>
3*4f1223e8SApple OSS Distributions<p>
4*4f1223e8SApple OSS Distributions<strong>Function</strong> - Return attributes of a clock.
5*4f1223e8SApple OSS Distributions<h3>SYNOPSIS</h3>
6*4f1223e8SApple OSS Distributions<pre>
7*4f1223e8SApple OSS Distributions<strong>kern_return_t   clock_get_attributes</strong>
8*4f1223e8SApple OSS Distributions                <strong>(clock_t</strong>                             <var>clock_name</var>,
9*4f1223e8SApple OSS Distributions                 <strong>clock_flavor_t</strong>                          <var>flavor</var>,
10*4f1223e8SApple OSS Distributions                 <strong>clock_attr_t</strong>                         <var>attribute</var>,
11*4f1223e8SApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>         <var>attribute_count</var><strong>);</strong>
12*4f1223e8SApple OSS Distributions</pre>
13*4f1223e8SApple OSS Distributions<h3>PARAMETERS</h3>
14*4f1223e8SApple OSS Distributions<dl>
15*4f1223e8SApple OSS Distributions<p>
16*4f1223e8SApple OSS Distributions<dt> <var>clock_name</var>
17*4f1223e8SApple OSS Distributions<dd>
18*4f1223e8SApple OSS Distributions[in clock-name send right]
19*4f1223e8SApple OSS DistributionsThe name (or control) port for the clock.
20*4f1223e8SApple OSS Distributions<p>
21*4f1223e8SApple OSS Distributions<dt> <var>flavor</var>
22*4f1223e8SApple OSS Distributions<dd>
23*4f1223e8SApple OSS Distributions[in scalar]
24*4f1223e8SApple OSS DistributionsType of information desired.  Defined values are:
25*4f1223e8SApple OSS Distributions<dl>
26*4f1223e8SApple OSS Distributions<p>
27*4f1223e8SApple OSS Distributions<dt> <strong>CLOCK_GET_TIME_RES</strong>
28*4f1223e8SApple OSS Distributions<dd>
29*4f1223e8SApple OSS DistributionsThe resolution, in nanoseconds, with which the value returned
30*4f1223e8SApple OSS Distributionsby <strong>clock_get_time</strong> is updated.
31*4f1223e8SApple OSS Distributions<p>
32*4f1223e8SApple OSS Distributions<dt> <strong>CLOCK_MAP_TIME_RES</strong>
33*4f1223e8SApple OSS Distributions<dd>
34*4f1223e8SApple OSS DistributionsThe resolution, in nanoseconds, with which the value visible
35*4f1223e8SApple OSS Distributionsvia <strong>clock_map_time</strong> is updated.
36*4f1223e8SApple OSS Distributions<p>
37*4f1223e8SApple OSS Distributions<dt> <strong>CLOCK_ALARM_CURRES</strong>
38*4f1223e8SApple OSS Distributions<dd>
39*4f1223e8SApple OSS DistributionsThe resolution, in nanoseconds, at which clock alarm and
40*4f1223e8SApple OSS Distributionssleep timers are currently serviced.
41*4f1223e8SApple OSS Distributions<p>
42*4f1223e8SApple OSS Distributions<dt> <strong>CLOCK_ALARM_MINRES</strong>
43*4f1223e8SApple OSS Distributions<dd>
44*4f1223e8SApple OSS DistributionsThe minimum resolution, in nanoseconds, at which clock
45*4f1223e8SApple OSS Distributionsalarm and sleep timers can be serviced.
46*4f1223e8SApple OSS Distributions<p>
47*4f1223e8SApple OSS Distributions<dt> <strong>CLOCK_ALARM_MAXRES</strong>
48*4f1223e8SApple OSS Distributions<dd>
49*4f1223e8SApple OSS DistributionsThe maximum resolution, in nanoseconds, at which clock
50*4f1223e8SApple OSS Distributionsalarm and sleep timers can be serviced.
51*4f1223e8SApple OSS Distributions</dl>
52*4f1223e8SApple OSS Distributions<p>
53*4f1223e8SApple OSS Distributions<dt> <var>attribute</var>
54*4f1223e8SApple OSS Distributions<dd>
55*4f1223e8SApple OSS Distributions[out scalar]
56*4f1223e8SApple OSS DistributionsThe returned attribute.
57*4f1223e8SApple OSS Distributions<p>
58*4f1223e8SApple OSS Distributions<dt> <var>attribute_count</var>
59*4f1223e8SApple OSS Distributions<dd>
60*4f1223e8SApple OSS Distributions[in/out scalar]
61*4f1223e8SApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
62*4f1223e8SApple OSS Distributionssize returned (in natural-sized units).
63*4f1223e8SApple OSS Distributions</dl>
64*4f1223e8SApple OSS Distributions<h3>DESCRIPTION</h3>
65*4f1223e8SApple OSS Distributions<p>
66*4f1223e8SApple OSS DistributionsThe <strong>clock_get_attributes</strong> function returns attributes of a clock's
67*4f1223e8SApple OSS Distributionsimplementation or operation.
68*4f1223e8SApple OSS Distributions<h3>RETURN VALUES</h3>
69*4f1223e8SApple OSS Distributions<p>
70*4f1223e8SApple OSS DistributionsOnly generic errors apply.
71*4f1223e8SApple OSS Distributions<h3>RELATED INFORMATION</h3>
72*4f1223e8SApple OSS Distributions<p>
73*4f1223e8SApple OSS DistributionsFunctions:
74*4f1223e8SApple OSS Distributions<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
75*4f1223e8SApple OSS Distributions<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
76*4f1223e8SApple OSS Distributions<a href="clock_map_time.html"><strong>clock_map_time</strong></a>,
77*4f1223e8SApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
78*4f1223e8SApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
79*4f1223e8SApple OSS Distributions<a href="clock_set_attributes.html"><strong>clock_set_attributes</strong></a>.
80