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