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

<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