xref: /xnu-10002.61.3/osfmk/man/clock_map_time.html (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions<h2>clock_map_time</h2>
2*0f4c859eSApple OSS Distributions<hr>
3*0f4c859eSApple OSS Distributions<p>
4*0f4c859eSApple OSS Distributions<strong>Function</strong> - Return a memory object that maps a clock.
5*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3>
6*0f4c859eSApple OSS Distributions<pre>
7*0f4c859eSApple OSS Distributions<strong>kern_return_t   clock_map_time</strong>
8*0f4c859eSApple OSS Distributions                <strong>(clock_t</strong>                             <var>clock_name</var>,
9*0f4c859eSApple OSS Distributions                 <strong>memory_object_t</strong>                   <var>clock_memory</var><strong>);</strong>
10*0f4c859eSApple OSS Distributions</pre>
11*0f4c859eSApple OSS Distributions<h3>PARAMETERS</h3>
12*0f4c859eSApple OSS Distributions<dl>
13*0f4c859eSApple OSS Distributions<p>
14*0f4c859eSApple OSS Distributions<dt> <var>clock_name</var>
15*0f4c859eSApple OSS Distributions<dd>
16*0f4c859eSApple OSS Distributions[in clock-name send right]
17*0f4c859eSApple OSS DistributionsThe name (or control) port for the clock.
18*0f4c859eSApple OSS Distributions<p>
19*0f4c859eSApple OSS Distributions<dt> <var>clock_memory</var>
20*0f4c859eSApple OSS Distributions<dd>
21*0f4c859eSApple OSS Distributions[out memory-object-representative send right]
22*0f4c859eSApple OSS DistributionsMapped clock time
23*0f4c859eSApple OSS Distributionsmemory object representative.
24*0f4c859eSApple OSS Distributions</dl>
25*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3>
26*0f4c859eSApple OSS Distributions<p>
27*0f4c859eSApple OSS DistributionsThe <strong>clock_map_time</strong> function returns a memory object representative port
28*0f4c859eSApple OSS Distributionsrepresenting read access to a memory object that contains (at offset zero) a
29*0f4c859eSApple OSS Distributionsmapped version of the clock time (structure <strong>mapped_tvalspec</strong>).
30*0f4c859eSApple OSS DistributionsThe returned right is suitable as an argument for <strong>vm_map</strong>.
31*0f4c859eSApple OSS Distributions<h3>NOTES</h3>
32*0f4c859eSApple OSS Distributions<p>
33*0f4c859eSApple OSS DistributionsNot all clocks provide this service, but the REALTIME clock must.
34*0f4c859eSApple OSS Distributions<h3>RETURN VALUES</h3>
35*0f4c859eSApple OSS Distributions<dl>
36*0f4c859eSApple OSS Distributions<p>
37*0f4c859eSApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
38*0f4c859eSApple OSS Distributions<dd>
39*0f4c859eSApple OSS DistributionsThe specified clock does not provide this service.
40*0f4c859eSApple OSS Distributions</dl>
41*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3>
42*0f4c859eSApple OSS Distributions<p>
43*0f4c859eSApple OSS DistributionsFunctions:
44*0f4c859eSApple OSS Distributions<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
45*0f4c859eSApple OSS Distributions<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
46*0f4c859eSApple OSS Distributions<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
47*0f4c859eSApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
48*0f4c859eSApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>.
49*0f4c859eSApple OSS Distributions<p>
50*0f4c859eSApple OSS DistributionsData Structures:
51*0f4c859eSApple OSS Distributions<a href="mapped_tvalspec.html"><strong>mapped_tvalspec</strong></a>.
52