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

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