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