xnu-7195.60.75.tar.gz

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

diff --git a/osfmk/man/ledger_read.html b/osfmk/man/ledger_read.html
old mode 100755 (executable)
new mode 100644 (file)
index fa28356..17ff288
--- a/osfmk/man/ledger_read.html
+++ b/osfmk/man/ledger_read.html
@@ -1 +1,47 @@
-<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
\ No newline at end of file
+<h2>ledger_read</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return the ledger limit and balance.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   ledger_read</strong>
+                <strong>(ledger_port_t</strong>                           <var>ledger</var>,
+                 <strong>ledger_item_t</strong>                          <var>balance</var>,
+                 <strong>ledger_item_t</strong>                          <var>maximum</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>ledger</var> 
+<dd>
+[in ledger send right]
+The ledger to read
+<p>
+<dt> <var>balance</var> 
+<dd>
+[out scalar]
+The current usage
+<p>
+<dt> <var>maximum</var> 
+<dd>
+[out scalar]
+The resource limit
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>ledger_read</strong> function returns the current balance
+and limit in a ledger.
+<h3>NOTES</h3>
+<p>
+This interface is not implemented in OSF/1 R1.3.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<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_transfer.html"><strong>ledger_transfer</strong></a>.
+
+