X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/743b15655a24ee3fe9f458f383003e011db0558f..13fec9890cf095cc781fdf7b8917cb03bf32dd4c:/osfmk/man/host_get_clock_service.html
diff --git a/osfmk/man/host_get_clock_service.html b/osfmk/man/host_get_clock_service.html
index b9c9ea09e..9d6b37039 100755
--- a/osfmk/man/host_get_clock_service.html
+++ b/osfmk/man/host_get_clock_service.html
@@ -1 +1,68 @@
-host_get_clock_service
Function - Return a send right to a kernel clock's service port.
SYNOPSIS
kern_return_t host_get_clock_service
(host_t host,
clock_id_t id,
clock_t clock_name);
PARAMETERS
- host
-
[in host-name send right]
The name (or control) port for the host
owning the clock.
- id
-
[in scalar]
The identification of the desired kernel clock. These values
are defined in \*L\*O. Although an implementation
may define additional values, the following values are always defined
(although only the REALTIME clock is required to be implemented):
- REALTIME_CLOCK
-
A moderate resolution clock service that (typically) tracks
time since the system last boot.
- BATTERY_CLOCK
-
A (typically) low resolution clock (to the second) that
survives power failures or service outages.
- HIGHRES_CLOCK
-
A high resolution clock.
- clock_name
-
[out clock-name send right]
Name port for the clock.
DESCRIPTION
The host_get_clock_service function returns a send
right to the name port for a
kernel clock object. This right is used to get the time and
resolutions of the
clock and to set clock alarms.
RETURN VALUES
Only generic errors apply.
RELATED INFORMATION
Functions:
clock_get_time,
clock_get_attributes,
clock_map_time,
clock_sleep,
clock_alarm,
host_get_clock_control.
\ No newline at end of file
+
host_get_clock_service
+
+
+Function - Return a send right to a kernel clock's service port.
+
SYNOPSIS
+
+kern_return_t host_get_clock_service
+ (host_t host,
+ clock_id_t id,
+ clock_t clock_name);
+
+PARAMETERS
+
+
+
- host
+
-
+[in host-name send right]
+The name (or control) port for the host
+owning the clock.
+
+
- id
+
-
+[in scalar]
+The identification of the desired kernel clock. These values
+are defined in \*L\*O. Although an implementation
+may define additional values, the following values are always defined
+(although only the REALTIME clock is required to be implemented):
+
+
+
- REALTIME_CLOCK
+
-
+A moderate resolution clock service that (typically) tracks
+time since the system last boot.
+
+
- BATTERY_CLOCK
+
-
+A (typically) low resolution clock (to the second) that
+survives power failures or service outages.
+
+
- HIGHRES_CLOCK
+
-
+A high resolution clock.
+
+
+
- clock_name
+
-
+[out clock-name send right]
+Name port for the clock.
+
+DESCRIPTION
+
+The host_get_clock_service function returns a send
+right to the name port for a
+kernel clock object. This right is used to get the time and
+resolutions of the
+clock and to set clock alarms.
+
RETURN VALUES
+
+Only generic errors apply.
+
RELATED INFORMATION
+
+Functions:
+clock_get_time,
+clock_get_attributes,
+clock_map_time,
+clock_sleep,
+clock_alarm,
+host_get_clock_control.