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

<h2>host_get_boot_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return operator boot information.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_get_boot_info</strong>\r                <strong>(host_priv_t</strong>                          <var>priv_host</var>,\r                 <strong>kernel_boot_info_t</strong>                   <var>boot_info</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>priv_host</var> \r<dd>\r[in host-control send right]\rThe control port for the host for which\rinformation is to be obtained.\r<p>\r<dt> <var>boot_info</var> \r<dd>\r[out array of char]\rCharacter string providing the operator boot info\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_get_boot_info</strong> function returns the boot-time information \rstring supplied by the operator when <var>priv_host</var> was initialized.  \rThe constant <strong>KERNEL_BOOT_INFO_MAX</strong> (in \*L<mach/host_info.h>\*O) \rshould be used to dimension storage for the returned string.\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