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

<h2>ledger_read</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the ledger limit and balance.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   ledger_read</strong>\r                <strong>(ledger_port_t</strong>                           <var>ledger</var>,\r                 <strong>ledger_item_t</strong>                          <var>balance</var>,\r                 <strong>ledger_item_t</strong>                          <var>maximum</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>ledger</var> \r<dd>\r[in ledger send right]\rThe ledger to read\r<p>\r<dt> <var>balance</var> \r<dd>\r[out scalar]\rThe current usage\r<p>\r<dt> <var>maximum</var> \r<dd>\r[out scalar]\rThe resource limit\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>ledger_read</strong> function returns the current balance\rand limit in a ledger.\r<h3>NOTES</h3>\r<p>\rThis interface is not implemented in OSF/1 R1.3.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="ledger_create.html"><strong>ledger_create</strong></a>,\r<a href="ledger_terminate.html"><strong>ledger_terminate</strong></a>,\r<a href="ledger_transfer.html"><strong>ledger_transfer</strong></a>.\r\r\r