xnu-2422.1.72.tar.gz

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

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