xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/ledger_transfer.html b/osfmk/man/ledger_transfer.html
index 60676a29cdfce531937d813b471df042df257a19..c703d50dafec4f680d13645d4a8ed81afb2f8d4c 100755 (executable)
--- a/osfmk/man/ledger_transfer.html
+++ b/osfmk/man/ledger_transfer.html
@@ -1 +1,51 @@
-<h2>ledger_transfer</h2>\r<hr>\r<p>\r<strong>Function</strong> - Transfer resources from a parent ledger to a child.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   ledger_transfer</strong>\r                <strong>(ledger_port_t</strong>                    <var>parent_ledger</var>,\r                 <strong>ledger_port_t</strong>                     <var>child_ledger</var>,\r                 <strong>ledger_item_t</strong>                         <var>transfer</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>parent_ledger</var> \r<dd>\r[in ledger send right]\rThe parent ledger\r<p>\r<dt> <var>child_ledger</var> \r<dd>\r[in ledger send right]\rThe child ledger\r<p>\r<dt> <var>transfer</var> \r<dd>\r[in scalar]\rThe resource amount to transfer.  A positive amount moves \rthe resource allocation from the parent to the child; a negative amount \rmoves the reverse.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>ledger_transfer</strong> function transfers resources from\ra parent to a child ledger.\r<h3>NOTES</h3>\r<p>\rThis interface is not implemented in OSF/1 R1.3.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_RESOURCE_SHORTAGE</strong>\r<dd>\rTransferring the resources would cause one ledger to exceed its limit.\r</dl>\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_read.html"><strong>ledger_read</strong></a>.\r
\ No newline at end of file
+<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>.