<h2>clock_map_time</h2>

<strong>Function</strong> - Return a memory object that maps a clock.

<h3>SYNOPSIS</h3>

<strong>kern_return_t clock_map_time</strong>

<strong>(clock_t</strong> <var>clock_name</var>,

<strong>memory_object_t</strong> <var>clock_memory</var><strong>);</strong>

<h3>PARAMETERS</h3>

<dt> <var>clock_name</var>

[in clock-name send right]

The name (or control) port for the clock.

<dt> <var>clock_memory</var>

[out memory-object-representative send right]

Mapped clock time

memory object representative.

<h3>DESCRIPTION</h3>

The <strong>clock_map_time</strong> function returns a memory object representative port

representing read access to a memory object that contains (at offset zero) a

mapped version of the clock time (structure <strong>mapped_tvalspec</strong>).

The returned right is suitable as an argument for <strong>vm_map</strong>.

<h3>NOTES</h3>

Not all clocks provide this service, but the REALTIME clock must.

<h3>RETURN VALUES</h3>

<dt> <strong>KERN_FAILURE</strong>

The specified clock does not provide this service.

<h3>RELATED INFORMATION</h3>

Functions:

<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,

<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,

<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,

<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,

<a href="clock_alarm.html"><strong>clock_alarm</strong></a>.

Data Structures:

<a href="mapped_tvalspec.html"><strong>mapped_tvalspec</strong></a>.