xref: /xnu-8020.140.41/osfmk/man/host_kernel_version.html (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1*27b03b36SApple OSS Distributions<h2>host_kernel_version</h2>
2*27b03b36SApple OSS Distributions<hr>
3*27b03b36SApple OSS Distributions<p>
4*27b03b36SApple OSS Distributions<strong>Function</strong> - Return kernel version information for a host.
5*27b03b36SApple OSS Distributions<h3>SYNOPSIS</h3>
6*27b03b36SApple OSS Distributions<pre>
7*27b03b36SApple OSS Distributions<strong>kern_return_t   host_kernel_version</strong>
8*27b03b36SApple OSS Distributions                <strong>(host_t</strong>                                    <var>host</var>,
9*27b03b36SApple OSS Distributions                 <strong>kernel_version_t</strong>                       <var>version</var><strong>);</strong>
10*27b03b36SApple OSS Distributions</pre>
11*27b03b36SApple OSS Distributions<h3>PARAMETERS</h3>
12*27b03b36SApple OSS Distributions<dl>
13*27b03b36SApple OSS Distributions<p>
14*27b03b36SApple OSS Distributions<dt> <var>host</var>
15*27b03b36SApple OSS Distributions<dd>
16*27b03b36SApple OSS Distributions[in host-name send right]
17*27b03b36SApple OSS DistributionsThe name (or control) port for the host for
18*27b03b36SApple OSS Distributionswhich information is to be obtained.
19*27b03b36SApple OSS Distributions<p>
20*27b03b36SApple OSS Distributions<dt> <var>version</var>
21*27b03b36SApple OSS Distributions<dd>
22*27b03b36SApple OSS Distributions[out array of <var>char</var>]
23*27b03b36SApple OSS DistributionsCharacter string describing the kernel version
24*27b03b36SApple OSS Distributionsexecuting on <var>host</var>.
25*27b03b36SApple OSS Distributions</dl>
26*27b03b36SApple OSS Distributions<h3>DESCRIPTION</h3>
27*27b03b36SApple OSS Distributions<p>
28*27b03b36SApple OSS DistributionsThe <strong>host_kernel_version</strong> function returns the version
29*27b03b36SApple OSS Distributionsstring compiled into the
30*27b03b36SApple OSS Distributionskernel executing on <var>host</var> at the time it was built.  This describes
31*27b03b36SApple OSS Distributionsthe version of the kernel.  The constant <strong>KERNEL_VERSION_MAX</strong> (in
32*27b03b36SApple OSS Distributions\*L<mach/host_info.h>\*O)
33*27b03b36SApple OSS Distributionsshould be used to dimension storage for the returned string if the
34*27b03b36SApple OSS Distributions<var>kernel_version_t</var> declaration is not used.
35*27b03b36SApple OSS Distributions<h3>RETURN VALUES</h3>
36*27b03b36SApple OSS Distributions<p>
37*27b03b36SApple OSS DistributionsOnly generic errors apply.
38*27b03b36SApple OSS Distributions<h3>RELATED INFORMATION</h3>
39*27b03b36SApple OSS Distributions<p>
40*27b03b36SApple OSS DistributionsFunctions:
41*27b03b36SApple OSS Distributions<a href="host_info.html"><strong>host_info</strong></a>.
42