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