X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..d41d1dae2cd00cc08c7982087d1c445180cad9f5:/osfmk/man/host_get_clock_control.html
diff --git a/osfmk/man/host_get_clock_control.html b/osfmk/man/host_get_clock_control.html
index 4d47043bb..42e1e00a9 100755
--- a/osfmk/man/host_get_clock_control.html
+++ b/osfmk/man/host_get_clock_control.html
@@ -1 +1,64 @@
-host_get_clock_control
Function - Return a send right to a kernel clock's control port.
SYNOPSIS
kern_return_t host_get_clock_control
(host_priv_t host_priv,
clock_id_t id,
clock_ctrl_t clock_control);
PARAMETERS
- host_priv
-
[in host-control send right]
The 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_control
-
[out clock-control send right]
Control port for the clock.
DESCRIPTION
The host_get_clock_control function returns a send
right to the control port for
a kernel clock object. This right is used to set the clock's
resolution and time.
RETURN VALUES
Only generic errors apply.
RELATED INFORMATION
Functions:
clock_set_time,
clock_set_attributes,
host_get_clock_service.
\ No newline at end of file
+
host_get_clock_control
+
+
+Function - Return a send right to a kernel clock's control port.
+
SYNOPSIS
+
+kern_return_t host_get_clock_control
+ (host_priv_t host_priv,
+ clock_id_t id,
+ clock_ctrl_t clock_control);
+
+PARAMETERS
+
+
+
- host_priv
+
-
+[in host-control send right]
+The 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_control
+
-
+[out clock-control send right]
+Control port for the clock.
+
+DESCRIPTION
+
+The host_get_clock_control function returns a send
+right to the control port for
+a kernel clock object. This right is used to set the clock's
+resolution and time.
+
RETURN VALUES
+
+Only generic errors apply.
+
RELATED INFORMATION
+
+Functions:
+clock_set_time,
+clock_set_attributes,
+host_get_clock_service.