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