xnu-792.6.76.tar.gz

[apple/xnu.git] / osfmk / man / clock_map_time.html

diff --git a/osfmk/man/clock_map_time.html b/osfmk/man/clock_map_time.html
index ce8fa443030276e0b541d6dbb2accfa4f567d48e..5859853b614786cacd90cb722b52ca40bb3131c3 100755 (executable)
--- a/osfmk/man/clock_map_time.html
+++ b/osfmk/man/clock_map_time.html
@@ -1 +1,51 @@
-<h2>clock_map_time</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return a memory object that maps a clock.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   clock_map_time</strong>\r                <strong>(clock_t</strong>                             <var>clock_name</var>,\r                 <strong>memory_object_t</strong>                   <var>clock_memory</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>clock_name</var> \r<dd>\r[in clock-name send right]\rThe name (or control) port for the clock.\r<p>\r<dt> <var>clock_memory</var> \r<dd>\r[out memory-object-representative send right]\rMapped clock time \rmemory object representative.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>clock_map_time</strong> function returns a memory object representative port\rrepresenting read access to a memory object that contains (at offset zero) a \rmapped version of the clock time (structure <strong>mapped_tvalspec</strong>).  \rThe returned right is suitable as an argument for <strong>vm_map</strong>.\r<h3>NOTES</h3>\r<p>\rNot all clocks provide this service, but the REALTIME clock must.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_FAILURE</strong>\r<dd>\rThe specified clock does not provide this service.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,\r<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,\r<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,\r<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,\r<a href="clock_alarm.html"><strong>clock_alarm</strong></a>.\r<p>\rData Structures:\r<a href="mapped_tvalspec.html"><strong>mapped_tvalspec</strong></a>.\r
\ No newline at end of file
+<h2>clock_map_time</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return a memory object that maps a clock.
+<h3>SYNOPSIS</h3>
+<pre>
+<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>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>clock_name</var> 
+<dd>
+[in clock-name send right]
+The name (or control) port for the clock.
+<p>
+<dt> <var>clock_memory</var> 
+<dd>
+[out memory-object-representative send right]
+Mapped clock time 
+memory object representative.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+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>
+<p>
+Not all clocks provide this service, but the REALTIME clock must.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_FAILURE</strong>
+<dd>
+The specified clock does not provide this service.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+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>.
+<p>
+Data Structures:
+<a href="mapped_tvalspec.html"><strong>mapped_tvalspec</strong></a>.