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