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