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