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