harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r724734 [35/46] - in /harmony/standard/site: docs/externals/kernel_doc/ docs/externals/kernel_doc/html/ docs/externals/vm_doc/ docs/externals/vm_doc/html/ docs/subcomponents/classlibrary/ xdocs/subcomponents/classlibrary/
Date Tue, 09 Dec 2008 15:03:51 GMT
Added: harmony/standard/site/docs/externals/vm_doc/html/hypool_8h.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hypool_8h.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hypool_8h.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hypool_8h.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,410 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: modules/portlib/src/main/native/include/shared/hypool.h File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li class="current"><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>modules/portlib/src/main/native/include/shared/hypool.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool Header. 
+<p>
+
+<p>
+<code>#include &quot;hycomp.h&quot;</code><br>
+<code>#include &quot;<a class="el" href="hyport_8h.html">hyport.h</a>&quot;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>HyPool</b></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>HyPoolState</b></td></tr>
+
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#cdc4233f475ea905a8ac7c4f5dc6e373">pool_do</a> (HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calls a user provided function for each element in the list.  <a href="#cdc4233f475ea905a8ac7c4f5dc6e373"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#59c054de28d8a47135d49b7123bd9168">pool_removeElement</a> (HyPool *aPool, void *anElement)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deallocates an element from a pool.  <a href="#59c054de28d8a47135d49b7123bd9168"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a1a3d7802177726a7e423bf01b89aa5a">pool_numElements</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of elements in a given pool.  <a href="#a1a3d7802177726a7e423bf01b89aa5a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#42794fcd0ff4bd0b23c804e413d44773">pool_newElement</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Asks for the address of a new pool element.  <a href="#42794fcd0ff4bd0b23c804e413d44773"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC HyPool *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#34fc514dd9f7339fe6507798a5497246">pool_forPortLib</a> (U_32 structSize, <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary.  <a href="#34fc514dd9f7339fe6507798a5497246"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#8a4a20e4530a7743c6162ef9c4784c52">pool_kill</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deallocates all memory associated with a pool.  <a href="#8a4a20e4530a7743c6162ef9c4784c52"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#600d884e1c775c7ab3e4045029098937">pool_sortFree</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sorts the free list of the current pool.  <a href="#600d884e1c775c7ab3e4045029098937"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#9cc68084517e52b49d9084774f2bbef1">pool_clear</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the contents of a pool but not delete it.  <a href="#9cc68084517e52b49d9084774f2bbef1"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#24912b026cff13bdfd343aeb1923caf2">pool_capacity</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total capacity of a pool.  <a href="#24912b026cff13bdfd343aeb1923caf2"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#fd789c0217f641b68729e951e5d54861">pool_ensureCapacity</a> (HyPool *aPool, UDATA newCapacity)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ensures that the pool is large enough for newCapacity elements.  <a href="#fd789c0217f641b68729e951e5d54861"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="24912b026cff13bdfd343aeb1923caf2"></a><!-- doxytag: member="hypool.h::pool_capacity" ref="24912b026cff13bdfd343aeb1923caf2" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC UDATA VMCALL pool_capacity           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the total capacity of a pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+numElements in aPool otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="9cc68084517e52b49d9084774f2bbef1"></a><!-- doxytag: member="hypool.h::pool_clear" ref="9cc68084517e52b49d9084774f2bbef1" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void VMCALL pool_clear           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Clear the contents of a pool but not delete it. 
+<p>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Make no assumptions about the contents of the pool after invoking this method (it currently does not zero the memory)</dd></dl>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to clear</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="cdc4233f475ea905a8ac7c4f5dc6e373"></a><!-- doxytag: member="hypool.h::pool_do" ref="cdc4233f475ea905a8ac7c4f5dc6e373" args="(HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void VMCALL pool_do           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void(*)(void *anElement, void *userData)&nbsp;</td>
+          <td class="paramname"> <em>aFunction</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>userData</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Calls a user provided function for each element in the list. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to "do" things to </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aFunction</em>&nbsp;</td><td>Pointer to function which will "do" things to the elements of aPool </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>userData</em>&nbsp;</td><td>Pointer to data to be passed to "do" function, along with each pool-element</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd>pool_startDo, pool_nextDo </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="fd789c0217f641b68729e951e5d54861"></a><!-- doxytag: member="hypool.h::pool_ensureCapacity" ref="fd789c0217f641b68729e951e5d54861" args="(HyPool *aPool, UDATA newCapacity)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC UDATA VMCALL pool_ensureCapacity           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>newCapacity</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Ensures that the pool is large enough for newCapacity elements. 
+<p>
+This has the side effect of setting the POOL_NEVER_FREE_PUDDLES flag. Without this, the pool could shrink back down to its original size. Note that this does not take into account the number of elements already used in the pool.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>newCapacity</em>&nbsp;</td><td>The desired new-size of the pool</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success <p>
+-1 on failure </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="34fc514dd9f7339fe6507798a5497246"></a><!-- doxytag: member="hypool.h::pool_forPortLib" ref="34fc514dd9f7339fe6507798a5497246" args="(U_32 structSize, HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC HyPool* VMCALL pool_forPortLib           </td>
+          <td>(</td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>structSize</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>structSize</em>&nbsp;</td><td>size of pool-element </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to a Pool</dd></dl>
+<dl class="see" compact><dt><b>See also:</b></dt><dd>pool_new </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="8a4a20e4530a7743c6162ef9c4784c52"></a><!-- doxytag: member="hypool.h::pool_kill" ref="8a4a20e4530a7743c6162ef9c4784c52" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void VMCALL pool_kill           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Deallocates all memory associated with a pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>Pool to be deallocated</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="42794fcd0ff4bd0b23c804e413d44773"></a><!-- doxytag: member="hypool.h::pool_newElement" ref="42794fcd0ff4bd0b23c804e413d44773" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void* VMCALL pool_newElement           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Asks for the address of a new pool element. 
+<p>
+If it succeeds, the address returned will have space for one element of the correct structure size. The contents of the element are undefined. If the current pool is full, a new one will be grafted onto the end of the pool chain and memory from there will be used.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL on error <p>
+pointer to a new element otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="a1a3d7802177726a7e423bf01b89aa5a"></a><!-- doxytag: member="hypool.h::pool_numElements" ref="a1a3d7802177726a7e423bf01b89aa5a" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC UDATA VMCALL pool_numElements           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the number of elements in a given pool. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+the number of elements in the pool otherwise </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="59c054de28d8a47135d49b7123bd9168"></a><!-- doxytag: member="hypool.h::pool_removeElement" ref="59c054de28d8a47135d49b7123bd9168" args="(HyPool *aPool, void *anElement)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void VMCALL pool_removeElement           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&nbsp;</td>
+          <td class="paramname"> <em>anElement</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Deallocates an element from a pool. 
+<p>
+It is safe to call <a class="el" href="pool_8c.html#3e3d8e0a0228e25263be24420389073c" title="Deallocates an element from a pool.">pool_removeElement()</a> while looping over the pool with <a class="el" href="pool_8c.html#pool_startDo">pool_startDo</a> / <a class="el" href="pool_8c.html#pool_nextDo">pool_nextDo</a> on the element returned by those calls. This is because the free element is always inserted at either the head of the free list or before the nextFree element in the pool_state.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>anElement</em>&nbsp;</td><td>Pointer to the element to be removed</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="600d884e1c775c7ab3e4045029098937"></a><!-- doxytag: member="hypool.h::pool_sortFree" ref="600d884e1c775c7ab3e4045029098937" args="(HyPool *aPool)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HY_CFUNC void VMCALL pool_sortFree           </td>
+          <td>(</td>
+          <td class="paramtype">HyPool *&nbsp;</td>
+          <td class="paramname"> <em>aPool</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Sorts the free list of the current pool. 
+<p>
+(ie: does not follow nextPool pointers...) This is a O(n) most of the time.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>aPool</em>&nbsp;</td><td>The pool to be sorted</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>none </dd></dl>
+
+</div>
+</div><p>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/hypool_8h.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/hyport_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hyport_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hyport_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hyport_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,452 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Harmony Class Library Porting: modules/portlib/src/main/native/port/shared/hyport.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.4 -->
+<div class="tabs">
+  <ul>
+    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="modules.html"><span>Modules</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li class="current"><a href="files.html"><span>Files</span></a></li>
+    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul>
+</div>
+<h1>modules/portlib/src/main/native/port/shared/hyport.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Port Library. 
+<p>
+
+<p>
+<code>#include &lt;string.h&gt;</code><br>
+<code>#include &quot;<a class="el" href="hyport_8h.html">hyport.h</a>&quot;</code><br>
+<code>#include &quot;portpriv.h&quot;</code><br>
+<code>#include &quot;hyportpg.h&quot;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#55b16df8fc66791ddfee00bf07eea69a">hyport_init_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, struct HyPortLibraryVersion *version, UDATA size)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the port library.  <a href="#55b16df8fc66791ddfee00bf07eea69a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#bcc874cbe8c1fad349324872295cb866">hyport_shutdown_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PortLibrary shutdown.  <a href="#bcc874cbe8c1fad349324872295cb866"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#1c13a9b3d737f08113ec5e363640fe78">hyport_create_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, struct HyPortLibraryVersion *version, UDATA size)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create the port library.  <a href="#1c13a9b3d737f08113ec5e363640fe78"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#7801547d07591a8d2c9aa49aadbda489">hyport_startup_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PortLibrary startup.  <a href="#7801547d07591a8d2c9aa49aadbda489"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#d69610f310e081a142b4a50b7537281c">hyport_getSize</a> (struct HyPortLibraryVersion *version)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the size of the port library.  <a href="#d69610f310e081a142b4a50b7537281c"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#bdca4793810219d0752b31b3f7f2ee25">hyport_getVersion</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, struct HyPortLibraryVersion *version)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the version of the port library.  <a href="#bdca4793810219d0752b31b3f7f2ee25"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#d14b823194ce93691cea16d31699f404">hyport_isCompatible</a> (struct HyPortLibraryVersion *expectedVersion)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine port library compatibility.  <a href="#d14b823194ce93691cea16d31699f404"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#6797ffeb546ed7fc7cc0027b06222eff">hyport_isFunctionOverridden</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA offset)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the port library.  <a href="#6797ffeb546ed7fc7cc0027b06222eff"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a4a0f076d68374552afb7a6bd708135a">hyport_allocate_library</a> (struct HyPortLibraryVersion *version, struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> **portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a port library.  <a href="#a4a0f076d68374552afb7a6bd708135a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#3e66c363eeca777c272105090b13e636">initNLSCatalog</a> (<a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLib)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the NLS catalog (must be done prior to any NLS usage).  <a href="#3e66c363eeca777c272105090b13e636"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a4a0f076d68374552afb7a6bd708135a"></a><!-- doxytag: member="hyport.c::hyport_allocate_library" ref="a4a0f076d68374552afb7a6bd708135a" args="(struct HyPortLibraryVersion *version, struct HyPortLibrary **portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_allocate_library           </td>
+          <td>(</td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>version</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> **&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Allocate a port library. 
+<p>
+Port library self allocation routines.<p>
+Given a pointer to the required version of the port library allocate and initialize the structure. The startup function is not called (<a class="el" href="hyport_8h.html#a8bbac248d082dd45ed14bd71e9c1d16">hyport_startup_library</a>) allowing the application to override any functions they desire. In the event <a class="el" href="hyport_8h.html#a8bbac248d082dd45ed14bd71e9c1d16">hyport_startup_library</a> fails when called by the application the port library memory will be freed.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>version</em>&nbsp;</td><td>The required version of the port library. </td></tr>
+    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>Pointer to the allocated port library table.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>portLibrary will be NULL on failure <p>
+The portlibrary version must be compatabile with the that which we are compiled against <p>
+<a class="el" href="hyport_8h.html#07f46ebf4a926c24fd1920c3e6111e33">hyport_shutdown_library</a> will deallocate this memory as part of regular shutdown </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="1c13a9b3d737f08113ec5e363640fe78"></a><!-- doxytag: member="hyport.c::hyport_create_library" ref="1c13a9b3d737f08113ec5e363640fe78" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_create_library           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>version</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Create the port library. 
+<p>
+Standard startup and shutdown (port library allocated on stack or by application).<p>
+Given a pointer to a port library and the required version, populate the port library table with the appropriate functions<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>version</em>&nbsp;</td><td>The required version of the port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>Size of the port library.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure </dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>The portlibrary version must be compatabile with the that which we are compiled against </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="d69610f310e081a142b4a50b7537281c"></a><!-- doxytag: member="hyport.c::hyport_getSize" ref="d69610f310e081a142b4a50b7537281c" args="(struct HyPortLibraryVersion *version)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">UDATA VMCALL hyport_getSize           </td>
+          <td>(</td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>version</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Determine the size of the port library. 
+<p>
+Given a port library version, return the size of the structure in bytes required to be allocated.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>version</em>&nbsp;</td><td>The HyPortLibraryVersion structure.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>size of port library on success, zero on failure</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>The portlibrary version must be compatabile with the that which we are compiled against </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="bdca4793810219d0752b31b3f7f2ee25"></a><!-- doxytag: member="hyport.c::hyport_getVersion" ref="bdca4793810219d0752b31b3f7f2ee25" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_getVersion           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>version</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Determine the version of the port library. 
+<p>
+Given a port library return the version of that instance.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The port library. </td></tr>
+    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>version</em>&nbsp;</td><td>The HyPortLibraryVersion structure to be populated.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure </dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>If portLibrary is NULL, version is populated with the version in the linked DLL </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="55b16df8fc66791ddfee00bf07eea69a"></a><!-- doxytag: member="hyport.c::hyport_init_library" ref="55b16df8fc66791ddfee00bf07eea69a" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_init_library           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>version</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Initialize the port library. 
+<p>
+Given a pointer to a port library and the required version, populate the port library table with the appropriate functions and then call the startup function for the port library.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>version</em>&nbsp;</td><td>The required version of the port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>Size of the port library.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="d14b823194ce93691cea16d31699f404"></a><!-- doxytag: member="hyport.c::hyport_isCompatible" ref="d14b823194ce93691cea16d31699f404" args="(struct HyPortLibraryVersion *expectedVersion)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_isCompatible           </td>
+          <td>(</td>
+          <td class="paramtype">struct HyPortLibraryVersion *&nbsp;</td>
+          <td class="paramname"> <em>expectedVersion</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Determine port library compatibility. 
+<p>
+Given the minimum version of the port library that the application requires determine if the current port library meets that requirements.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>expectedVersion</em>&nbsp;</td><td>The version the application requires as a minimum.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if compatible, 0 if not compatible </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="6797ffeb546ed7fc7cc0027b06222eff"></a><!-- doxytag: member="hyport.c::hyport_isFunctionOverridden" ref="6797ffeb546ed7fc7cc0027b06222eff" args="(struct HyPortLibrary *portLibrary, UDATA offset)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_isFunctionOverridden           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>offset</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Query the port library. 
+<p>
+Given a pointer to the port library and an offset into the table determine if the function at that offset has been overridden from the default value expected.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>offset</em>&nbsp;</td><td>The offset of the function to be queried.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the function is overriden, else 0.</dd></dl>
+hyport_isFunctionOverridden(portLibrary, offsetof(HyPortLibrary, mem_allocate_memory)); 
+</div>
+</div><p>
+<a class="anchor" name="bcc874cbe8c1fad349324872295cb866"></a><!-- doxytag: member="hyport.c::hyport_shutdown_library" ref="bcc874cbe8c1fad349324872295cb866" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_shutdown_library           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+PortLibrary shutdown. 
+<p>
+Shutdown the port library, de-allocate resources required by the components of the portlibrary. Any resources that werer created by <a class="el" href="hyport_8h.html#a8bbac248d082dd45ed14bd71e9c1d16">hyport_startup_library</a> should be destroyed here.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The portlibrary.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative return code on failure </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="7801547d07591a8d2c9aa49aadbda489"></a><!-- doxytag: member="hyport.c::hyport_startup_library" ref="7801547d07591a8d2c9aa49aadbda489" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyport_startup_library           </td>
+          <td>(</td>
+          <td class="paramtype">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLibrary</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+PortLibrary startup. 
+<p>
+Start the port library, allocate resources required by the components of the portlibrary. All resources created here should be destroyed in <a class="el" href="hyport_8h.html#07f46ebf4a926c24fd1920c3e6111e33">hyport_shutdown_library</a>.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portLibrary</em>&nbsp;</td><td>The portlibrary.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, negative error code on failure. Error code values returned are <ul>
+<li>HYPORT_ERROR_STARTUP_THREAD </li>
+<li>HYPORT_ERROR_STARTUP_MEM </li>
+<li>HYPORT_ERROR_STARTUP_TLS </li>
+<li>HYPORT_ERROR_STARTUP_TLS_ALLOC </li>
+<li>HYPORT_ERROR_STARTUP_TLS_MUTEX </li>
+<li>HYPORT_ERROR_STARTUP_ERROR </li>
+<li>HYPORT_ERROR_STARTUP_CPU </li>
+<li>HYPORT_ERROR_STARTUP_VMEM </li>
+<li>HYPORT_ERROR_STARTUP_FILE </li>
+<li>HYPORT_ERROR_STARTUP_TTY </li>
+<li>HYPORT_ERROR_STARTUP_TTY_HANDLE </li>
+<li>HYPORT_ERROR_STARTUP_TTY_CONSOLE </li>
+<li>HYPORT_ERROR_STARTUP_MMAP </li>
+<li>HYPORT_ERROR_STARTUP_IPCMUTEX </li>
+<li>HYPORT_ERROR_STARTUP_NLS </li>
+<li>HYPORT_ERROR_STARTUP_SOCK </li>
+<li>HYPORT_ERROR_STARTUP_TIME </li>
+<li>HYPORT_ERROR_STARTUP_GP </li>
+<li>HYPORT_ERROR_STARTUP_EXIT </li>
+<li>HYPORT_ERROR_STARTUP_SYSINFO </li>
+<li>HYPORT_ERROR_STARTUP_SL </li>
+<li>HYPORT_ERROR_STARTUP_STR </li>
+<li>HYPORT_ERROR_STARTUP_SHSEM </li>
+<li>HYPORT_ERROR_STARTUP_SHMEM </li>
+<li>HYPORT_ERROR_STARTUP_SIGNAL</li>
+</ul>
+</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>The port library memory is deallocated if it was created by <a class="el" href="hyport_8h.html#ad4e1b391086debb7e183c4c79ab1089">hyport_allocate_library</a> </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="3e66c363eeca777c272105090b13e636"></a><!-- doxytag: member="hyport.c::initNLSCatalog" ref="3e66c363eeca777c272105090b13e636" args="(HyPortLibrary *portLib)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void initNLSCatalog           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *&nbsp;</td>
+          <td class="paramname"> <em>portLib</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Initialize the NLS catalog (must be done prior to any NLS usage). 
+<p>
+
+</div>
+</div><p>
+<hr size="1">
+<address style="text-align: center;">
+  <small>
+    <p>Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.</p>
+    <p>(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable. </p>
+  </small>
+</address>
+</body>
+</html>

Propchange: harmony/standard/site/docs/externals/vm_doc/html/hyport_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message