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