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