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