xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / host_kernel_version.html

<h2>host_kernel_version</h2>
<hr>
<p>
<strong>Function</strong> - Return kernel version information for a host.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   host_kernel_version</strong>
                <strong>(host_t</strong>                                    <var>host</var>,
                 <strong>kernel_version_t</strong>                       <var>version</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>host</var> 
<dd>
[in host-name send right]
The name (or control) port for the host for 
which information is to be obtained.
<p>
<dt> <var>version</var> 
<dd>
[out array of <var>char</var>]
Character string describing the kernel version
executing on <var>host</var>.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_kernel_version</strong> function returns the version
string compiled into the 
kernel executing on <var>host</var> at the time it was built.  This describes
the version of the kernel.  The constant <strong>KERNEL_VERSION_MAX</strong> (in 
\*L<mach/host_info.h>\*O) 
should be used to dimension storage for the returned string if the
<var>kernel_version_t</var> declaration is not used.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_info.html"><strong>host_info</strong></a>.