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