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