osfmk/man/clock_get_attributes.html

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