xref: /xnu-11215/osfmk/man/ledger_transfer.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>ledger_transfer</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Transfer resources from a parent ledger to a child.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>kern_return_t   ledger_transfer</strong>
8*e13b1fa5SApple OSS Distributions                <strong>(ledger_port_t</strong>                    <var>parent_ledger</var>,
9*e13b1fa5SApple OSS Distributions                 <strong>ledger_port_t</strong>                     <var>child_ledger</var>,
10*e13b1fa5SApple OSS Distributions                 <strong>ledger_item_t</strong>                         <var>transfer</var><strong>);</strong>
11*e13b1fa5SApple OSS Distributions</pre>
12*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
13*e13b1fa5SApple OSS Distributions<dl>
14*e13b1fa5SApple OSS Distributions<p>
15*e13b1fa5SApple OSS Distributions<dt> <var>parent_ledger</var>
16*e13b1fa5SApple OSS Distributions<dd>
17*e13b1fa5SApple OSS Distributions[in ledger send right]
18*e13b1fa5SApple OSS DistributionsThe parent ledger
19*e13b1fa5SApple OSS Distributions<p>
20*e13b1fa5SApple OSS Distributions<dt> <var>child_ledger</var>
21*e13b1fa5SApple OSS Distributions<dd>
22*e13b1fa5SApple OSS Distributions[in ledger send right]
23*e13b1fa5SApple OSS DistributionsThe child ledger
24*e13b1fa5SApple OSS Distributions<p>
25*e13b1fa5SApple OSS Distributions<dt> <var>transfer</var>
26*e13b1fa5SApple OSS Distributions<dd>
27*e13b1fa5SApple OSS Distributions[in scalar]
28*e13b1fa5SApple OSS DistributionsThe resource amount to transfer.  A positive amount moves
29*e13b1fa5SApple OSS Distributionsthe resource allocation from the parent to the child; a negative amount
30*e13b1fa5SApple OSS Distributionsmoves the reverse.
31*e13b1fa5SApple OSS Distributions</dl>
32*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
33*e13b1fa5SApple OSS Distributions<p>
34*e13b1fa5SApple OSS DistributionsThe <strong>ledger_transfer</strong> function transfers resources from
35*e13b1fa5SApple OSS Distributionsa parent to a child ledger.
36*e13b1fa5SApple OSS Distributions<h3>NOTES</h3>
37*e13b1fa5SApple OSS Distributions<p>
38*e13b1fa5SApple OSS DistributionsThis interface is not implemented in OSF/1 R1.3.
39*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
40*e13b1fa5SApple OSS Distributions<dl>
41*e13b1fa5SApple OSS Distributions<p>
42*e13b1fa5SApple OSS Distributions<dt> <strong>KERN_RESOURCE_SHORTAGE</strong>
43*e13b1fa5SApple OSS Distributions<dd>
44*e13b1fa5SApple OSS DistributionsTransferring the resources would cause one ledger to exceed its limit.
45*e13b1fa5SApple OSS Distributions</dl>
46*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*e13b1fa5SApple OSS Distributions<p>
48*e13b1fa5SApple OSS DistributionsFunctions:
49*e13b1fa5SApple OSS Distributions<a href="ledger_create.html"><strong>ledger_create</strong></a>,
50*e13b1fa5SApple OSS Distributions<a href="ledger_terminate.html"><strong>ledger_terminate</strong></a>,
51*e13b1fa5SApple OSS Distributions<a href="ledger_read.html"><strong>ledger_read</strong></a>.
52