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