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