osfmk/man/ledger_read.html

   1 <h2>ledger_read</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return the ledger limit and balance.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   ledger_read</strong>
   8                 <strong>(ledger_port_t</strong>                           <var>ledger</var>,
   9                  <strong>ledger_item_t</strong>                          <var>balance</var>,
  10                  <strong>ledger_item_t</strong>                          <var>maximum</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>ledger</var>
  16 <dd>
  17 [in ledger send right]
  18 The ledger to read
  19 <p>
  20 <dt> <var>balance</var>
  21 <dd>
  22 [out scalar]
  23 The current usage
  24 <p>
  25 <dt> <var>maximum</var>
  26 <dd>
  27 [out scalar]
  28 The resource limit
  29 </dl>
  30 <h3>DESCRIPTION</h3>
  31 <p>
  32 The <strong>ledger_read</strong> function returns the current balance
  33 and limit in a ledger.
  34 <h3>NOTES</h3>
  35 <p>
  36 This interface is not implemented in OSF/1 R1.3.
  37 <h3>RETURN VALUES</h3>
  38 <p>
  39 Only generic errors apply.
  40 <h3>RELATED INFORMATION</h3>
  41 <p>
  42 Functions:
  43 <a href="ledger_create.html"><strong>ledger_create</strong></a>,
  44 <a href="ledger_terminate.html"><strong>ledger_terminate</strong></a>,
  45 <a href="ledger_transfer.html"><strong>ledger_transfer</strong></a>.
  46
  47