osfmk/man/ledger_transfer.html

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