X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..HEAD:/osfmk/man/clock_get_attributes.html diff --git a/osfmk/man/clock_get_attributes.html b/osfmk/man/clock_get_attributes.html old mode 100755 new mode 100644 index 62fecf084..2ece755a2 --- a/osfmk/man/clock_get_attributes.html +++ b/osfmk/man/clock_get_attributes.html @@ -1 +1,79 @@ -

clock_get_attributes


Function - Return attributes of a clock.

SYNOPSIS

kern_return_t   clock_get_attributes
                (clock_t                             clock_name,
                 clock_flavor_t                          flavor,
                 clock_attr_t                         attribute,
                 mach_msg_type_number_t         attribute_count);

PARAMETERS

clock_name
[in clock-name send right] The name (or control) port for the clock.

flavor
[in scalar] Type of information desired. Defined values are:

CLOCK_GET_TIME_RES
The resolution, in nanoseconds, with which the value returned by clock_get_time is updated.

CLOCK_MAP_TIME_RES
The resolution, in nanoseconds, with which the value visible via clock_map_time is updated.

CLOCK_ALARM_CURRES
The resolution, in nanoseconds, at which clock alarm and sleep timers are currently serviced.

CLOCK_ALARM_MINRES
The minimum resolution, in nanoseconds, at which clock alarm and sleep timers can be serviced.

CLOCK_ALARM_MAXRES
The maximum resolution, in nanoseconds, at which clock alarm and sleep timers can be serviced.

attribute
[out scalar] The returned attribute.

attribute_count
[in/out scalar] On input, the maximum size of the buffer; on output, the size returned (in natural-sized units).

DESCRIPTION

The clock_get_attributes function returns attributes of a clock's implementation or operation.

RETURN VALUES

Only generic errors apply.

RELATED INFORMATION

Functions: host_get_clock_service, clock_get_time, clock_map_time, clock_sleep, clock_alarm, clock_set_attributes. \ No newline at end of file +

clock_get_attributes

+
+

+Function - Return attributes of a clock. +

SYNOPSIS

+
+kern_return_t   clock_get_attributes
+                (clock_t                             clock_name,
+                 clock_flavor_t                          flavor,
+                 clock_attr_t                         attribute,
+                 mach_msg_type_number_t         attribute_count);
+
+

PARAMETERS

+
+

+

clock_name +
+[in clock-name send right] +The name (or control) port for the clock. +

+

flavor +
+[in scalar] +Type of information desired. Defined values are: +
+

+

CLOCK_GET_TIME_RES +
+The resolution, in nanoseconds, with which the value returned +by clock_get_time is updated. +

+

CLOCK_MAP_TIME_RES +
+The resolution, in nanoseconds, with which the value visible +via clock_map_time is updated. +

+

CLOCK_ALARM_CURRES +
+The resolution, in nanoseconds, at which clock alarm and +sleep timers are currently serviced. +

+

CLOCK_ALARM_MINRES +
+The minimum resolution, in nanoseconds, at which clock +alarm and sleep timers can be serviced. +

+

CLOCK_ALARM_MAXRES +
+The maximum resolution, in nanoseconds, at which clock +alarm and sleep timers can be serviced. +
+

+

attribute +
+[out scalar] +The returned attribute. +

+

attribute_count +
+[in/out scalar] +On input, the maximum size of the buffer; on output, the +size returned (in natural-sized units). +
+

DESCRIPTION

+

+The clock_get_attributes function returns attributes of a clock's +implementation or operation. +

RETURN VALUES

+

+Only generic errors apply. +

RELATED INFORMATION

+

+Functions: +host_get_clock_service, +clock_get_time, +clock_map_time, +clock_sleep, +clock_alarm, +clock_set_attributes.