osfmk/man/host_get_boot_info.html

   1 <h2>host_get_boot_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return operator boot information.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   host_get_boot_info</strong>
   8                 <strong>(host_priv_t</strong>                          <var>priv_host</var>,
   9                  <strong>kernel_boot_info_t</strong>                   <var>boot_info</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <p>
  14 <dt> <var>priv_host</var>
  15 <dd>
  16 [in host-control send right]
  17 The control port for the host for which
  18 information is to be obtained.
  19 <p>
  20 <dt> <var>boot_info</var>
  21 <dd>
  22 [out array of char]
  23 Character string providing the operator boot info
  24 </dl>
  25 <h3>DESCRIPTION</h3>
  26 <p>
  27 The <strong>host_get_boot_info</strong> function returns the boot-time information
  28 string supplied by the operator when <var>priv_host</var> was initialized.
  29 The constant <strong>KERNEL_BOOT_INFO_MAX</strong> (in \*L<mach/host_info.h>\*O)
  30 should be used to dimension storage for the returned string.
  31 <h3>RETURN VALUES</h3>
  32 <p>
  33 Only generic errors apply.
  34 <h3>RELATED INFORMATION</h3>
  35 <p>
  36 Functions:
  37 <a href="host_info.html"><strong>host_info</strong></a>.