1*1031c584SApple OSS Distributions<h2>host_get_clock_service</h2> 2*1031c584SApple OSS Distributions<hr> 3*1031c584SApple OSS Distributions<p> 4*1031c584SApple OSS Distributions<strong>Function</strong> - Return a send right to a kernel clock's service port. 5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3> 6*1031c584SApple OSS Distributions<pre> 7*1031c584SApple OSS Distributions<strong>kern_return_t host_get_clock_service</strong> 8*1031c584SApple OSS Distributions <strong>(host_t</strong> <var>host</var>, 9*1031c584SApple OSS Distributions <strong>clock_id_t</strong> <var>id</var>, 10*1031c584SApple OSS Distributions <strong>clock_t</strong> <var>clock_name</var><strong>);</strong> 11*1031c584SApple OSS Distributions</pre> 12*1031c584SApple OSS Distributions<h3>PARAMETERS</h3> 13*1031c584SApple OSS Distributions<dl> 14*1031c584SApple OSS Distributions<p> 15*1031c584SApple OSS Distributions<dt> <var>host</var> 16*1031c584SApple OSS Distributions<dd> 17*1031c584SApple OSS Distributions[in host-name send right] 18*1031c584SApple OSS DistributionsThe name (or control) port for the host 19*1031c584SApple OSS Distributionsowning the clock. 20*1031c584SApple OSS Distributions<p> 21*1031c584SApple OSS Distributions<dt> <var>id</var> 22*1031c584SApple OSS Distributions<dd> 23*1031c584SApple OSS Distributions[in scalar] 24*1031c584SApple OSS DistributionsThe identification of the desired kernel clock. These values 25*1031c584SApple OSS Distributionsare defined in \*L<mach/clock_types.h>\*O. Although an implementation 26*1031c584SApple OSS Distributionsmay define additional values, the following values are always defined 27*1031c584SApple OSS Distributions(although only the REALTIME clock is required to be implemented): 28*1031c584SApple OSS Distributions<dl> 29*1031c584SApple OSS Distributions<p> 30*1031c584SApple OSS Distributions<dt> <strong>REALTIME_CLOCK</strong> 31*1031c584SApple OSS Distributions<dd> 32*1031c584SApple OSS DistributionsA moderate resolution clock service that (typically) tracks 33*1031c584SApple OSS Distributionstime since the system last boot. 34*1031c584SApple OSS Distributions<p> 35*1031c584SApple OSS Distributions<dt> <strong>BATTERY_CLOCK</strong> 36*1031c584SApple OSS Distributions<dd> 37*1031c584SApple OSS DistributionsA (typically) low resolution clock (to the second) that 38*1031c584SApple OSS Distributionssurvives power failures or service outages. 39*1031c584SApple OSS Distributions<p> 40*1031c584SApple OSS Distributions<dt> <strong>HIGHRES_CLOCK</strong> 41*1031c584SApple OSS Distributions<dd> 42*1031c584SApple OSS DistributionsA high resolution clock. 43*1031c584SApple OSS Distributions</dl> 44*1031c584SApple OSS Distributions<p> 45*1031c584SApple OSS Distributions<dt> <var>clock_name</var> 46*1031c584SApple OSS Distributions<dd> 47*1031c584SApple OSS Distributions[out clock-name send right] 48*1031c584SApple OSS DistributionsName port for the clock. 49*1031c584SApple OSS Distributions</dl> 50*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3> 51*1031c584SApple OSS Distributions<p> 52*1031c584SApple OSS DistributionsThe <strong>host_get_clock_service</strong> function returns a send 53*1031c584SApple OSS Distributionsright to the name port for a 54*1031c584SApple OSS Distributionskernel clock object. This right is used to get the time and 55*1031c584SApple OSS Distributionsresolutions of the 56*1031c584SApple OSS Distributionsclock and to set clock alarms. 57*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3> 58*1031c584SApple OSS Distributions<p> 59*1031c584SApple OSS DistributionsOnly generic errors apply. 60*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3> 61*1031c584SApple OSS Distributions<p> 62*1031c584SApple OSS DistributionsFunctions: 63*1031c584SApple OSS Distributions<a href="clock_get_time.html"><strong>clock_get_time</strong></a>, 64*1031c584SApple OSS Distributions<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>, 65*1031c584SApple OSS Distributions<a href="clock_map_time.html"><strong>clock_map_time</strong></a>, 66*1031c584SApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>, 67*1031c584SApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>, 68*1031c584SApple OSS Distributions<a href="host_get_clock_control.html"><strong>host_get_clock_control</strong></a>. 69