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