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

<h2>clock_get_attributes</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return attributes of a clock.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   clock_get_attributes</strong>\r                <strong>(clock_t</strong>                             <var>clock_name</var>,\r                 <strong>clock_flavor_t</strong>                          <var>flavor</var>,\r                 <strong>clock_attr_t</strong>                         <var>attribute</var>,\r                 <strong>mach_msg_type_number_t</strong>         <var>attribute_count</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>flavor</var> \r<dd>\r[in scalar]\rType of information desired.  Defined values are:\r<dl>\r<p>\r<dt> <strong>CLOCK_GET_TIME_RES</strong>\r<dd>\rThe resolution, in nanoseconds, with which the value returned \rby <strong>clock_get_time</strong> is updated.\r<p>\r<dt> <strong>CLOCK_MAP_TIME_RES</strong>\r<dd>\rThe resolution, in nanoseconds, with which the value visible \rvia <strong>clock_map_time</strong> is updated.\r<p>\r<dt> <strong>CLOCK_ALARM_CURRES</strong>\r<dd>\rThe resolution, in nanoseconds, at which clock alarm and \rsleep timers are currently serviced.\r<p>\r<dt> <strong>CLOCK_ALARM_MINRES</strong>\r<dd>\rThe minimum resolution, in nanoseconds, at which clock \ralarm and sleep timers can be serviced.\r<p>\r<dt> <strong>CLOCK_ALARM_MAXRES</strong>\r<dd>\rThe maximum resolution, in nanoseconds, at which clock \ralarm and sleep timers can be serviced.\r</dl>\r<p>\r<dt> <var>attribute</var> \r<dd>\r[out scalar]\rThe returned attribute.\r<p>\r<dt> <var>attribute_count</var> \r<dd>\r[in/out scalar]\rOn input, the maximum size of the buffer; on output, the \rsize returned (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>clock_get_attributes</strong> function returns attributes of a clock's\rimplementation or operation.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\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_time.html"><strong>clock_get_time</strong></a>,\r<a href="clock_map_time.html"><strong>clock_map_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<a href="clock_set_attributes.html"><strong>clock_set_attributes</strong></a>.\r