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