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