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