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