xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / ledger_transfer.html

<h2>ledger_transfer</h2>
<hr>
<p>
<strong>Function</strong> - Transfer resources from a parent ledger to a child.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   ledger_transfer</strong>
                <strong>(ledger_port_t</strong>                    <var>parent_ledger</var>,
                 <strong>ledger_port_t</strong>                     <var>child_ledger</var>,
                 <strong>ledger_item_t</strong>                         <var>transfer</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>parent_ledger</var> 
<dd>
[in ledger send right]
The parent ledger
<p>
<dt> <var>child_ledger</var> 
<dd>
[in ledger send right]
The child ledger
<p>
<dt> <var>transfer</var> 
<dd>
[in scalar]
The resource amount to transfer.  A positive amount moves 
the resource allocation from the parent to the child; a negative amount 
moves the reverse.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>ledger_transfer</strong> function transfers resources from
a parent to a child ledger.
<h3>NOTES</h3>
<p>
This interface is not implemented in OSF/1 R1.3.
<h3>RETURN VALUES</h3>
<dl>
<p>
<dt> <strong>KERN_RESOURCE_SHORTAGE</strong>
<dd>
Transferring the resources would cause one ledger to exceed its limit.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="ledger_create.html"><strong>ledger_create</strong></a>,
<a href="ledger_terminate.html"><strong>ledger_terminate</strong></a>,
<a href="ledger_read.html"><strong>ledger_read</strong></a>.