harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r724734 [34/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/hyipcmutex_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,191 @@
+<!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/windows/hyipcmutex.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/windows/hyipcmutex.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Shared Resource Mutex. 
+<p>
+The HYIPCMutex is used to protect a shared resource from simultaneous access by processes or threads executing in the same or different VMs. Each process/thread must request and wait for the ownership of the shared resource before it can use that resource. It must also release the ownership of the resource as soon as it has finished using it so that other processes competing for the same resource are not delayed. 
+<p>
+<code>#include &lt;windows.h&gt;</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>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="hyipcmutex_8c.html#fdb89188cb0bcf406ffb6a3c0c488186">hyipcmutex_acquire</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, const char *name)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Acquires a named mutex for the calling process.  <a href="#fdb89188cb0bcf406ffb6a3c0c488186"></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="hyipcmutex_8c.html#ee161064b253a445501e36ab97c41e72">hyipcmutex_release</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, const char *name)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a named Mutex from the calling process.  <a href="#ee161064b253a445501e36ab97c41e72"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyipcmutex_8c.html#990899c0954644badef708e910306895">hyipcmutex_shutdown</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="#990899c0954644badef708e910306895"></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="hyipcmutex_8c.html#f37f2bc313b3f091d3213895320dbe57">hyipcmutex_startup</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="#f37f2bc313b3f091d3213895320dbe57"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="fdb89188cb0bcf406ffb6a3c0c488186"></a><!-- doxytag: member="hyipcmutex.c::hyipcmutex_acquire" ref="fdb89188cb0bcf406ffb6a3c0c488186" args="(struct HyPortLibrary *portLibrary, const char *name)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyipcmutex_acquire           </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">const char *&nbsp;</td>
+          <td class="paramname"> <em>name</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>
+Acquires a named mutex for the calling process. 
+<p>
+If a Mutex with the same Name already exists, the function opens the existing Mutex and tries to lock it. If another process already has the Mutex locked, the function will block indefinitely. If there is no Mutex with the same Name, the function will create it and lock it for the calling process of this function.<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>name</em>&nbsp;</td><td>Mutex to be acquired</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error.</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>The Mutex must be explicitly released by calling the <a class="el" href="hyipcmutex_8c.html#ee161064b253a445501e36ab97c41e72">hyipcmutex_release</a> function as soon as the lock is no longer required. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="ee161064b253a445501e36ab97c41e72"></a><!-- doxytag: member="hyipcmutex.c::hyipcmutex_release" ref="ee161064b253a445501e36ab97c41e72" args="(struct HyPortLibrary *portLibrary, const char *name)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyipcmutex_release           </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">const char *&nbsp;</td>
+          <td class="paramname"> <em>name</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>
+Releases a named Mutex from the calling process. 
+<p>
+If a Mutex with the same Name already exists, the function opens the existing Mutex and tries to unlock it. This function will fail if a Mutex with the given Name is not found or if the Mutex cannot be unlocked.<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>name</em>&nbsp;</td><td>Mutex to be released.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error.</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Callers of this function must have called the function <a class="el" href="hyipcmutex_8c.html#fdb89188cb0bcf406ffb6a3c0c488186">hyipcmutex_acquire</a> prior to calling this function. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="990899c0954644badef708e910306895"></a><!-- doxytag: member="hyipcmutex.c::hyipcmutex_shutdown" ref="990899c0954644badef708e910306895" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hyipcmutex_shutdown           </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>
+This function is called during shutdown of the portLibrary. Any resources that were created by <a class="el" href="hyipcmutex_8c.html#f37f2bc313b3f091d3213895320dbe57">hyipcmutex_startup</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 port library</td></tr>
+  </table>
+</dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Most implementations will be empty. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f37f2bc313b3f091d3213895320dbe57"></a><!-- doxytag: member="hyipcmutex.c::hyipcmutex_startup" ref="f37f2bc313b3f091d3213895320dbe57" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hyipcmutex_startup           </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>
+This function is called during startup of the portLibrary. Any resources that are required for the IPC mutex operations may be created here. All resources created here should be destroyed in <a class="el" href="hyipcmutex_8c.html#990899c0954644badef708e910306895">hyipcmutex_shutdown</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 port library</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_IPCMUTEX</li>
+</ul>
+</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Most implementations will simply return success. </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/hyipcmutex_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,298 @@
+<!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/windows/hymem.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/windows/hymem.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Memory Utilities. 
+<p>
+
+<p>
+<code>#include &lt;windows.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>
+<code>#include &quot;ut_hyprt.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">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymem_8c.html#9783a2413a6169fae26a6d9c41e6e18d">hymem_allocate_memory</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA byteAmount)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate memory.  <a href="#9783a2413a6169fae26a6d9c41e6e18d"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymem_8c.html#ce4594dc299a3addfde007aa44c74df9">hymem_free_memory</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, void *memoryPointer)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deallocate memory.  <a href="#ce4594dc299a3addfde007aa44c74df9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymem_8c.html#67f7e50ff8280bbcdcba5e3f80951bf6">hymem_reallocate_memory</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, void *memoryPointer, UDATA byteAmount)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Re-allocate memory.  <a href="#67f7e50ff8280bbcdcba5e3f80951bf6"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymem_8c.html#f58571498a57107d2537851e89c7517e">hymem_shutdown</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="#f58571498a57107d2537851e89c7517e"></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="hymem_8c.html#242bef4bc6b4e37d2f1326b5db3c17f6">hymem_startup</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA portGlobalSize)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PortLibrary startup.  <a href="#242bef4bc6b4e37d2f1326b5db3c17f6"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymem_8c.html#f2b33a1705efc6bf70ca6b6ce18be2f1">hymem_allocate_memory_callSite</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA byteAmount, char *callSite)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate memory.  <a href="#f2b33a1705efc6bf70ca6b6ce18be2f1"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="9783a2413a6169fae26a6d9c41e6e18d"></a><!-- doxytag: member="hymem.c::hymem_allocate_memory" ref="9783a2413a6169fae26a6d9c41e6e18d" args="(struct HyPortLibrary *portLibrary, UDATA byteAmount)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* VMCALL hymem_allocate_memory           </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>byteAmount</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 memory. 
+<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>byteAmount</em>&nbsp;</td><td>Number of bytes to allocate.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to memory on success, NULL on error. <p>
+Memory is not guaranteed to be zeroed as part of this call </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f2b33a1705efc6bf70ca6b6ce18be2f1"></a><!-- doxytag: member="hymem.c::hymem_allocate_memory_callSite" ref="f2b33a1705efc6bf70ca6b6ce18be2f1" args="(struct HyPortLibrary *portLibrary, UDATA byteAmount, char *callSite)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* VMCALL hymem_allocate_memory_callSite           </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>byteAmount</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">char *&nbsp;</td>
+          <td class="paramname"> <em>callSite</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 memory. 
+<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>byteAmount</em>&nbsp;</td><td>Number of bytes to allocate. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>callSite</em>&nbsp;</td><td>String describing callsite, usually file and line number.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to memory on success, NULL on error. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="ce4594dc299a3addfde007aa44c74df9"></a><!-- doxytag: member="hymem.c::hymem_free_memory" ref="ce4594dc299a3addfde007aa44c74df9" args="(struct HyPortLibrary *portLibrary, void *memoryPointer)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hymem_free_memory           </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">void *&nbsp;</td>
+          <td class="paramname"> <em>memoryPointer</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>
+Deallocate memory. 
+<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>memoryPointer</em>&nbsp;</td><td>Base address of memory to be deallocated. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="67f7e50ff8280bbcdcba5e3f80951bf6"></a><!-- doxytag: member="hymem.c::hymem_reallocate_memory" ref="67f7e50ff8280bbcdcba5e3f80951bf6" args="(struct HyPortLibrary *portLibrary, void *memoryPointer, UDATA byteAmount)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* VMCALL hymem_reallocate_memory           </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">void *&nbsp;</td>
+          <td class="paramname"> <em>memoryPointer</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UDATA&nbsp;</td>
+          <td class="paramname"> <em>byteAmount</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>
+Re-allocate memory. 
+<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>memoryPointer</em>&nbsp;</td><td>Base address of memory to be re-allocated. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>byteAmount</em>&nbsp;</td><td>Number of bytes to re-allocated.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to memory on success, NULL on error. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f58571498a57107d2537851e89c7517e"></a><!-- doxytag: member="hymem.c::hymem_shutdown" ref="f58571498a57107d2537851e89c7517e" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hymem_shutdown           </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>
+This function is called during shutdown of the portLibrary. Any resources that were created by <a class="el" href="hymem_8c.html#242bef4bc6b4e37d2f1326b5db3c17f6">hymem_startup</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 port library</td></tr>
+  </table>
+</dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Must deallocate portGlobals. <p>
+Most implementations will just deallocate portGlobals. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="242bef4bc6b4e37d2f1326b5db3c17f6"></a><!-- doxytag: member="hymem.c::hymem_startup" ref="242bef4bc6b4e37d2f1326b5db3c17f6" args="(struct HyPortLibrary *portLibrary, UDATA portGlobalSize)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hymem_startup           </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>portGlobalSize</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>
+PortLibrary startup. 
+<p>
+This function is called during startup of the portLibrary. Any resources that are required for the memory operations may be created here. All resources created here should be destroyed in <a class="el" href="hymem_8c.html#f58571498a57107d2537851e89c7517e">hymem_shutdown</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 port library </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>portGlobalSize</em>&nbsp;</td><td>Size of the global data structure to allocate</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_MEM</li>
+</ul>
+</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Must allocate portGlobals. <p>
+Most implementations will just allocate portGlobals. </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/hymem_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,222 @@
+<!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/windows/hymmap.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/windows/hymmap.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Memory map. 
+<p>
+This module provides memory mapping facilities that allow a user to map files into the virtual address space of the process. There are various options that can be used when mapping a file into memory, such as copy on write. Not all of these options are available on all platforms, <a class="el" href="hymmap_8c.html#6917c00b5ffb1d94cadd36a08c18ea4c">hymmap_capabilities</a> provides the list of supported options. Note also that on some platforms memory mapping facilites do not exist at all. On these platforms the API will still be available, but will simply read the file into allocated memory. 
+<p>
+<code>#include &lt;windows.h&gt;</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>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymmap_8c.html#79d155211a64e1bf7699d50154c21603">hymmap_map_file</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, const char *path, void **handle)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Map a file into memory.  <a href="#79d155211a64e1bf7699d50154c21603"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymmap_8c.html#de85af702c38c0c8897c785bad45a175">hymmap_unmap_file</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, void *handle)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">UnMap previously mapped memory.  <a href="#de85af702c38c0c8897c785bad45a175"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hymmap_8c.html#847d961ed5ac2bdd388c079b7261ae22">hymmap_shutdown</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="#847d961ed5ac2bdd388c079b7261ae22"></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="hymmap_8c.html#38a658fbd704c8ce7b082526ec1bf06b">hymmap_startup</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="#38a658fbd704c8ce7b082526ec1bf06b"></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="hymmap_8c.html#6917c00b5ffb1d94cadd36a08c18ea4c">hymmap_capabilities</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check the capabilities available for HYMMAP at runtime for the current platform.  <a href="#6917c00b5ffb1d94cadd36a08c18ea4c"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="6917c00b5ffb1d94cadd36a08c18ea4c"></a><!-- doxytag: member="hymmap.c::hymmap_capabilities" ref="6917c00b5ffb1d94cadd36a08c18ea4c" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hymmap_capabilities           </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>
+Check the capabilities available for HYMMAP at runtime for the current platform. 
+<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>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>a bit map containing the capabilites supported by the hymmap sub component of the port library. Possible bit values: HYPORT_MMAP_CAPABILITY_COPYONWRITE - if not present, platform is not capable of "copy on write" memory mapping. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="79d155211a64e1bf7699d50154c21603"></a><!-- doxytag: member="hymmap.c::hymmap_map_file" ref="79d155211a64e1bf7699d50154c21603" args="(struct HyPortLibrary *portLibrary, const char *path, void **handle)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* VMCALL hymmap_map_file           </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">const char *&nbsp;</td>
+          <td class="paramname"> <em>path</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void **&nbsp;</td>
+          <td class="paramname"> <em>handle</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>
+Map a file into memory. 
+<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>path</em>&nbsp;</td><td>- the path of the file to mapped into memory. </td></tr>
+    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>handle</em>&nbsp;</td><td>- updates *handle with the memory map handle, this handle is later passed to unmap.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to newly mapped memory on success, NULL on error. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="847d961ed5ac2bdd388c079b7261ae22"></a><!-- doxytag: member="hymmap.c::hymmap_shutdown" ref="847d961ed5ac2bdd388c079b7261ae22" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hymmap_shutdown           </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>
+<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>
+  </table>
+</dl>
+This function is called during shutdown of the portLibrary. Any resources that were created by <a class="el" href="hymmap_8c.html#38a658fbd704c8ce7b082526ec1bf06b">hymmap_startup</a> should be destroyed here. 
+</div>
+</div><p>
+<a class="anchor" name="38a658fbd704c8ce7b082526ec1bf06b"></a><!-- doxytag: member="hymmap.c::hymmap_startup" ref="38a658fbd704c8ce7b082526ec1bf06b" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hymmap_startup           </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>
+This function is called during startup of the portLibrary. Any resources that are required for the memory mapping operations may be created here. All resources created here should be destroyed in <a class="el" href="hymmap_8c.html#847d961ed5ac2bdd388c079b7261ae22">hymmap_shutdown</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 port library</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_MMAP</li>
+</ul>
+</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>Most implementations will simply return success. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="de85af702c38c0c8897c785bad45a175"></a><!-- doxytag: member="hymmap.c::hymmap_unmap_file" ref="de85af702c38c0c8897c785bad45a175" args="(struct HyPortLibrary *portLibrary, void *handle)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hymmap_unmap_file           </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">void *&nbsp;</td>
+          <td class="paramname"> <em>handle</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>
+UnMap previously mapped memory. 
+<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>handle</em>&nbsp;</td><td>- the handle from the mmap_map_file. </td></tr>
+  </table>
+</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/hymmap_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,502 @@
+<!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/hynls.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/hynls.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Native language support. 
+<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>
+<code>#include &quot;portpriv.h&quot;</code><br>
+<code>#include &quot;hythread.h&quot;</code><br>
+<code>#include &quot;hynlshelpers.h&quot;</code><br>
+<code>#include &quot;portnls.h&quot;</code><br>
+<code>#include &lt;stdlib.h&gt;</code><br>
+<code>#include &lt;string.h&gt;</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">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#39dc7ad6b7377a13945ab3e433b0a087">hynls_set_locale</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, const char *lang, const char *region, const char *variant)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the language, region, and variant of the locale.  <a href="#39dc7ad6b7377a13945ab3e433b0a087"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#87f09de2d93d713e1d5b41362c6e450f">hynls_get_language</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the string representing the currently set language.  <a href="#87f09de2d93d713e1d5b41362c6e450f"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a65cf4f1d62568df51e5009e2e0a0230">hynls_get_region</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the string representing the currently set region.  <a href="#a65cf4f1d62568df51e5009e2e0a0230"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#774cd9fccd91af173c9118a6876a0be3">hynls_get_variant</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the string representing the currently set variant.  <a href="#774cd9fccd91af173c9118a6876a0be3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#591a0c1805506b7b7f4cabc2e0834d05">hynls_printf</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA flags, U_32 module_name, U_32 message_num,...)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a formatted NLS message.  <a href="#591a0c1805506b7b7f4cabc2e0834d05"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#160dde9284bea5b88a454a1f8537ad9f">hynls_vprintf</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, va_list args)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a formatted NLS message.  <a href="#160dde9284bea5b88a454a1f8537ad9f"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#830d885705efc770fe1db9ae8f27ac9b">hynls_lookup_message</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, const char *default_string)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the NLS string for the module name and message number.  <a href="#830d885705efc770fe1db9ae8f27ac9b"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#898a1dce29671a5394db0de29e2287a8">hynls_set_catalog</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, const char **paths, const int nPaths, const char *baseName, const char *extension)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setup the path to the NLS catalog.  <a href="#898a1dce29671a5394db0de29e2287a8"></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="hynls_8c.html#c39654515be7091a76ca29e3f9182e35">hynls_startup</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="#c39654515be7091a76ca29e3f9182e35"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#240e408a1d77fec27802393aca3b6446">hynls_shutdown</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="#240e408a1d77fec27802393aca3b6446"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="87f09de2d93d713e1d5b41362c6e450f"></a><!-- doxytag: member="hynls.c::hynls_get_language" ref="87f09de2d93d713e1d5b41362c6e450f" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* VMCALL hynls_get_language           </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>
+Return the string representing the currently set language. 
+<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>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>language string </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="a65cf4f1d62568df51e5009e2e0a0230"></a><!-- doxytag: member="hynls.c::hynls_get_region" ref="a65cf4f1d62568df51e5009e2e0a0230" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* VMCALL hynls_get_region           </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>
+Return the string representing the currently set region. 
+<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>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>region string </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="774cd9fccd91af173c9118a6876a0be3"></a><!-- doxytag: member="hynls.c::hynls_get_variant" ref="774cd9fccd91af173c9118a6876a0be3" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* VMCALL hynls_get_variant           </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>
+Return the string representing the currently set variant. 
+<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>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>variant string </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="830d885705efc770fe1db9ae8f27ac9b"></a><!-- doxytag: member="hynls.c::hynls_lookup_message" ref="830d885705efc770fe1db9ae8f27ac9b" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, const char *default_string)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* VMCALL hynls_lookup_message           </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>flags</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>module_name</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>message_num</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>default_string</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>
+Return the NLS string for the module name and message number. 
+<p>
+If no string is found, or a failure occurs, return the default_string.<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>flags</em>&nbsp;</td><td>- to indicate what type of message (e.g., ERROR) and whether a newline is required </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>module_name</em>&nbsp;</td><td>- the module identifier of the NLS message </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>message_num</em>&nbsp;</td><td>- the NLS message number within the module </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>default_string</em>&nbsp;</td><td>- a default message, in case no NLS message is found</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>NLS String </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="591a0c1805506b7b7f4cabc2e0834d05"></a><!-- doxytag: member="hynls.c::hynls_printf" ref="591a0c1805506b7b7f4cabc2e0834d05" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num,...)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hynls_printf           </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>flags</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>module_name</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>message_num</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&nbsp;</td>
+          <td class="paramname"> <em>...</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>
+Print a formatted NLS message. 
+<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>flags</em>&nbsp;</td><td>- to indicate what type of message (e.g., ERROR) and whether a newline is required </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>module_name</em>&nbsp;</td><td>- the module identifier of the NLS message </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>message_num</em>&nbsp;</td><td>- the NLS message number within the module </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>...</em>&nbsp;</td><td>- arguments used in the NLS message format </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="898a1dce29671a5394db0de29e2287a8"></a><!-- doxytag: member="hynls.c::hynls_set_catalog" ref="898a1dce29671a5394db0de29e2287a8" args="(struct HyPortLibrary *portLibrary, const char **paths, const int nPaths, const char *baseName, const char *extension)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hynls_set_catalog           </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">const char **&nbsp;</td>
+          <td class="paramname"> <em>paths</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const int&nbsp;</td>
+          <td class="paramname"> <em>nPaths</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>baseName</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>extension</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>
+Setup the path to the NLS catalog. 
+<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>paths</em>&nbsp;</td><td>- an array of directory paths where the NLS catalog may be found </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>nPaths</em>&nbsp;</td><td>- the number of entries in the paths array </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>baseName</em>&nbsp;</td><td>- the lead name of the catalog file name (i.e., the "java" in java_en_US.properties) </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>extension</em>&nbsp;</td><td>- the extension of the catalog file name (i.e., the "properties in java_en_US.properties) </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="39dc7ad6b7377a13945ab3e433b0a087"></a><!-- doxytag: member="hynls.c::hynls_set_locale" ref="39dc7ad6b7377a13945ab3e433b0a087" args="(struct HyPortLibrary *portLibrary, const char *lang, const char *region, const char *variant)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hynls_set_locale           </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">const char *&nbsp;</td>
+          <td class="paramname"> <em>lang</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>region</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>variant</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>
+Set the language, region, and variant of the locale. 
+<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>lang</em>&nbsp;</td><td>- the language of the locale (e.g., "en"), 2 characters or less </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>region</em>&nbsp;</td><td>- the region of the locale (e.g., "US"), 2 characters or less </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>variant</em>&nbsp;</td><td>- the variant of the locale (e.g., "boont"), 31 characters or less </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="240e408a1d77fec27802393aca3b6446"></a><!-- doxytag: member="hynls.c::hynls_shutdown" ref="240e408a1d77fec27802393aca3b6446" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hynls_shutdown           </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>
+This function is called during shutdown of the portLibrary. Any resources that were created by <a class="el" href="hynls_8c.html#c39654515be7091a76ca29e3f9182e35">hynls_startup</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 port library </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="c39654515be7091a76ca29e3f9182e35"></a><!-- doxytag: member="hynls.c::hynls_startup" ref="c39654515be7091a76ca29e3f9182e35" args="(struct HyPortLibrary *portLibrary)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">I_32 VMCALL hynls_startup           </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>
+This function is called during startup of the portLibrary. Any resources that are required for the NLS library operations may be created here. All resources created here should be destroyed in <a class="el" href="hynls_8c.html#240e408a1d77fec27802393aca3b6446">hynls_shutdown</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 port library</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_NLS </li>
+</ul>
+</dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="160dde9284bea5b88a454a1f8537ad9f"></a><!-- doxytag: member="hynls.c::hynls_vprintf" ref="160dde9284bea5b88a454a1f8537ad9f" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, va_list args)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void VMCALL hynls_vprintf           </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>flags</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>module_name</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U_32&nbsp;</td>
+          <td class="paramname"> <em>message_num</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">va_list&nbsp;</td>
+          <td class="paramname"> <em>args</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>
+Print a formatted NLS message. 
+<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>flags</em>&nbsp;</td><td>- to indicate what type of message (e.g., ERROR) and whether a newline is required </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>module_name</em>&nbsp;</td><td>- the module identifier of the NLS message </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>message_num</em>&nbsp;</td><td>- the NLS message number within the module </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>args</em>&nbsp;</td><td>- arguments used in the NLS message format </td></tr>
+  </table>
+</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/hynls_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html?rev=724734&view=auto
==============================================================================
--- harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html (added)
+++ harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html Tue Dec  9 07:03:45 2008
@@ -0,0 +1,104 @@
+<!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/windows/hyosdump.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/windows/hyosdump.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Dump formatting. 
+<p>
+
+<p>
+<code>#include &lt;windows.h&gt;</code><br>
+<code>#include &lt;winnt.h&gt;</code><br>
+<code>#include &lt;stdlib.h&gt;</code><br>
+<code>#include &lt;float.h&gt;</code><br>
+<code>#include &lt;process.h&gt;</code><br>
+<code>#include &lt;dbghelp.h&gt;</code><br>
+<code>#include &quot;<a class="el" href="hyport_8h.html">hyport.h</a>&quot;</code><br>
+<code>#include &quot;hysignal.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">UDATA VMCALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="hyosdump_8c.html#9aca29ffdfa597c2a7d90dffbc7c8fea">hydump_create</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, char *filename, char *dumpType, void *userData)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a dump file of the OS state.  <a href="#9aca29ffdfa597c2a7d90dffbc7c8fea"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="9aca29ffdfa597c2a7d90dffbc7c8fea"></a><!-- doxytag: member="hyosdump.c::hydump_create" ref="9aca29ffdfa597c2a7d90dffbc7c8fea" args="(struct HyPortLibrary *portLibrary, char *filename, char *dumpType, void *userData)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">UDATA VMCALL hydump_create           </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">char *&nbsp;</td>
+          <td class="paramname"> <em>filename</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">char *&nbsp;</td>
+          <td class="paramname"> <em>dumpType</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>
+Create a dump file of the OS 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>portLibrary</em>&nbsp;</td><td>The port library. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>filename</em>&nbsp;</td><td>Buffer for filename optionally containing the filename where dump is to be output. </td></tr>
+    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>filename</em>&nbsp;</td><td>filename used for dump file or error message. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>dumpType</em>&nbsp;</td><td>Type of dump to perform. </td></tr>
+    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>userData</em>&nbsp;</td><td>Implementation specific data.</td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, non-zero otherwise.</dd></dl>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>filename buffer can not be NULL. <p>
+user allocates and frees filename buffer. <p>
+filename buffer length is platform dependent, assumed to be HyMaxPath/MAX_PATH<p>
+if filename buffer is empty, a filename will be generated. <p>
+if HYUNIQUE_DUMPS is set, filename will be unique. </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/hyosdump_8c.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message