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