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