You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by ge...@apache.org on 2005/12/01 07:04:00 UTC
svn commit: r350181 [38/198] - in
/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core: ./ depends/
depends/files/ depends/jars/ depends/libs/ depends/libs/linux.IA32/
depends/libs/win.IA32/ depends/oss/ depends/oss/linux.IA32/
depends/oss/win.I...
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hynls_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hynls_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hynls_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hynls_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,574 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/port/hynls.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000007.html">port</a></div>
+<h1>hynls.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Native language support.
+<p>
+
+<p>
+<code>#include "hycomp.h"</code><br>
+<code>#include "<a class="el" href="hyport_8h.html">hyport.h</a>"</code><br>
+<code>#include "portpriv.h"</code><br>
+<code>#include "hythread.h"</code><br>
+<code>#include "hynlshelpers.h"</code><br>
+<code>#include "portnls.h"</code><br>
+<code>#include <stdlib.h></code><br>
+<code>#include <string.h></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a41">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"> </td><td class="mdescRight">Set the language, region, and variant of the locale. <a href="#a41"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a42">hynls_get_language</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string representing the currently set language. <a href="#a42"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a43">hynls_get_region</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string representing the currently set region. <a href="#a43"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a44">hynls_get_variant</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string representing the currently set variant. <a href="#a44"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a45">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"> </td><td class="mdescRight">Print a formatted NLS message. <a href="#a45"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a46">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"> </td><td class="mdescRight">Print a formatted NLS message. <a href="#a46"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a47">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"> </td><td class="mdescRight">Return the NLS string for the module name and message number. <a href="#a47"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a48">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"> </td><td class="mdescRight">Setup the path to the NLS catalog. <a href="#a48"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a49">hynls_startup</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">PortLibrary startup. <a href="#a49"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hynls_8c.html#a50">hynls_shutdown</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">PortLibrary shutdown. <a href="#a50"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a42"></a><!-- doxytag: member="hynls.c::hynls_get_language" ref="a42" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">const char* VMCALL hynls_get_language </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>language string</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a43"></a><!-- doxytag: member="hynls.c::hynls_get_region" ref="a43" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">const char* VMCALL hynls_get_region </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>region string</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a44"></a><!-- doxytag: member="hynls.c::hynls_get_variant" ref="a44" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">const char* VMCALL hynls_get_variant </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>variant string</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a47"></a><!-- doxytag: member="hynls.c::hynls_lookup_message" ref="a47" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, const char *default_string)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">const char* VMCALL hynls_lookup_message </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>flags</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>module_name</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>message_num</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>default_string</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>flags</em> </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> </td><td valign="top"><em>module_name</em> </td><td>- the module identifier of the NLS message </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>message_num</em> </td><td>- the NLS message number within the module </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>default_string</em> </td><td>- a default message, in case no NLS message is found</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>NLS String</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a45"></a><!-- doxytag: member="hynls.c::hynls_printf" ref="a45" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num,...)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void VMCALL hynls_printf </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>flags</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>module_name</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>message_num</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap> </td>
+ <td class="mdname" nowrap> <em>...</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>flags</em> </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> </td><td valign="top"><em>module_name</em> </td><td>- the module identifier of the NLS message </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>message_num</em> </td><td>- the NLS message number within the module </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>...</em> </td><td>- arguments used in the NLS message format</td></tr>
+ </table>
+</dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a48"></a><!-- doxytag: member="hynls.c::hynls_set_catalog" ref="a48" args="(struct HyPortLibrary *portLibrary, const char **paths, const int nPaths, const char *baseName, const char *extension)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void VMCALL hynls_set_catalog </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char ** </td>
+ <td class="mdname" nowrap> <em>paths</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const int </td>
+ <td class="mdname" nowrap> <em>nPaths</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>baseName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>extension</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>paths</em> </td><td>- an array of directory paths where the NLS catalog may be found </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nPaths</em> </td><td>- the number of entries in the paths array </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>baseName</em> </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> </td><td valign="top"><em>extension</em> </td><td>- the extension of the catalog file name (i.e., the "properties in java_en_US.properties)</td></tr>
+ </table>
+</dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a41"></a><!-- doxytag: member="hynls.c::hynls_set_locale" ref="a41" args="(struct HyPortLibrary *portLibrary, const char *lang, const char *region, const char *variant)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void VMCALL hynls_set_locale </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>lang</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>region</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>const char * </td>
+ <td class="mdname" nowrap> <em>variant</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lang</em> </td><td>- the language of the locale (e.g., "en"), 2 characters or less </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>region</em> </td><td>- the region of the locale (e.g., "US"), 2 characters or less </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>variant</em> </td><td>- the variant of the locale (e.g., "boont"), 31 characters or less</td></tr>
+ </table>
+</dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a50"></a><!-- doxytag: member="hynls.c::hynls_shutdown" ref="a50" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void VMCALL hynls_shutdown </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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#a49">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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library</td></tr>
+ </table>
+</dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a49"></a><!-- doxytag: member="hynls.c::hynls_startup" ref="a49" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hynls_startup </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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#a50">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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library</td></tr>
+ </table>
+</dl>
+<dl 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>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a46"></a><!-- doxytag: member="hynls.c::hynls_vprintf" ref="a46" args="(struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, va_list args)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void VMCALL hynls_vprintf </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>flags</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>module_name</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>message_num</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>va_list </td>
+ <td class="mdname" nowrap> <em>args</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>flags</em> </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> </td><td valign="top"><em>module_name</em> </td><td>- the module identifier of the NLS message </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>message_num</em> </td><td>- the NLS message number within the module </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>args</em> </td><td>- arguments used in the NLS message format</td></tr>
+ </table>
+</dl>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyosdump_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyosdump_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyosdump_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyosdump_8c.html Wed Nov 30 21:29:27 2005
@@ -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=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/port/hyosdump.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000007.html">port</a></div>
+<h1>hyosdump.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Dump formatting.
+<p>
+
+<p>
+<code>#include <windows.h></code><br>
+<code>#include <winnt.h></code><br>
+<code>#include <stdlib.h></code><br>
+<code>#include <float.h></code><br>
+<code>#include <process.h></code><br>
+<code>#include <dbghelp.h></code><br>
+<code>#include "<a class="el" href="hyport_8h.html">hyport.h</a>"</code><br>
+<code>#include "hysignal.h"</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="hyosdump_8c.html#a31">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"> </td><td class="mdescRight">Create a dump file of the OS state. <a href="#a31"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a31"></a><!-- doxytag: member="hyosdump.c::hydump_create" ref="a31" args="(struct HyPortLibrary *portLibrary, char *filename, char *dumpType, void *userData)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">UDATA VMCALL hydump_create </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>char * </td>
+ <td class="mdname" nowrap> <em>filename</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>char * </td>
+ <td class="mdname" nowrap> <em>dumpType</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>userData</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>filename</em> </td><td>Buffer for filename optionally containing the filename where dump is to be output. </td></tr>
+ <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>filename</em> </td><td>filename used for dump file or error message. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dumpType</em> </td><td>Type of dump to perform. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>userData</em> </td><td>Implementation specific data.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, non-zero otherwise.</dd></dl>
+<dl 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>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hypool_8h.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hypool_8h.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hypool_8h.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hypool_8h.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,482 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/include/hypool.h File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000005.html">include</a></div>
+<h1>hypool.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool Header.
+<p>
+
+<p>
+<code>#include "hycomp.h"</code><br>
+<code>#include "<a class="el" href="hyport_8h.html">hyport.h</a>"</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 </td><td class="memItemRight" valign="bottom"><b>HyPool</b></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a12">pool_do</a> (HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls a user provided function for each element in the list. <a href="#a12"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a15">pool_removeElement</a> (HyPool *aPool, void *anElement)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates an element from a pool. <a href="#a15"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a16">pool_numElements</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in a given pool. <a href="#a16"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a18">pool_newElement</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Asks for the address of a new pool element. <a href="#a18"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC HyPool *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a19">pool_forPortLib</a> (U_32 structSize, <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </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="#a19"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a20">pool_kill</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates all memory associated with a pool. <a href="#a20"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a21">pool_sortFree</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Sorts the free list of the current pool. <a href="#a21"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a22">pool_clear</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the contents of a pool but not delete it. <a href="#a22"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a23">pool_capacity</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total capacity of a pool. <a href="#a23"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HY_CFUNC UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hypool_8h.html#a24">pool_ensureCapacity</a> (HyPool *aPool, UDATA newCapacity)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensures that the pool is large enough for newCapacity elements. <a href="#a24"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a23"></a><!-- doxytag: member="hypool.h::pool_capacity" ref="a23" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC UDATA VMCALL pool_capacity </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td>The pool</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+numElements in aPool otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a22"></a><!-- doxytag: member="hypool.h::pool_clear" ref="a22" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void VMCALL pool_clear </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Clear the contents of a pool but not delete it.
+<p>
+<dl 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> </td><td valign="top"><em>aPool</em> </td><td>The pool to clear</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a12"></a><!-- doxytag: member="hypool.h::pool_do" ref="a12" args="(HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void VMCALL pool_do </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void(*)(void *anElement, void *userData) </td>
+ <td class="mdname" nowrap> <em>aFunction</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>userData</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td>The pool to "do" things to </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aFunction</em> </td><td>Pointer to function which will "do" things to the elements of aPool </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>userData</em> </td><td>Pointer to data to be passed to "do" function, along with each pool-element</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd>pool_startDo, pool_nextDo</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a24"></a><!-- doxytag: member="hypool.h::pool_ensureCapacity" ref="a24" args="(HyPool *aPool, UDATA newCapacity)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC UDATA VMCALL pool_ensureCapacity </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>newCapacity</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td>The pool </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>newCapacity</em> </td><td>The desired new-size of the pool</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success <p>
+-1 on failure</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a19"></a><!-- doxytag: member="hypool.h::pool_forPortLib" ref="a19" args="(U_32 structSize, HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC HyPool* VMCALL pool_forPortLib </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">U_32 </td>
+ <td class="mdname" nowrap> <em>structSize</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>structSize</em> </td><td>size of pool-element </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>portLibrary</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>pointer to a Pool</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd>pool_new</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a20"></a><!-- doxytag: member="hypool.h::pool_kill" ref="a20" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void VMCALL pool_kill </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td>Pool to be deallocated</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a18"></a><!-- doxytag: member="hypool.h::pool_newElement" ref="a18" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void* VMCALL pool_newElement </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>NULL on error <p>
+pointer to a new element otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a16"></a><!-- doxytag: member="hypool.h::pool_numElements" ref="a16" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC UDATA VMCALL pool_numElements </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+the number of elements in the pool otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a15"></a><!-- doxytag: member="hypool.h::pool_removeElement" ref="a15" args="(HyPool *aPool, void *anElement)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void VMCALL pool_removeElement </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>anElement</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Deallocates an element from a pool.
+<p>
+It is safe to call <a class="el" href="pool_8c.html#a7">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> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>anElement</em> </td><td>Pointer to the element to be removed</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a21"></a><!-- doxytag: member="hypool.h::pool_sortFree" ref="a21" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">HY_CFUNC void VMCALL pool_sortFree </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>aPool</em> </td><td>The pool to be sorted</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyport_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyport_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyport_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/hyport_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,522 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/port/hyport.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000007.html">port</a></div>
+<h1>hyport.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Port Library.
+<p>
+
+<p>
+<code>#include <string.h></code><br>
+<code>#include "<a class="el" href="hyport_8h.html">hyport.h</a>"</code><br>
+<code>#include "portpriv.h"</code><br>
+<code>#include "hyportpg.h"</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a0">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"> </td><td class="mdescRight">Initialize the port library. <a href="#a0"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a1">hyport_shutdown_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">PortLibrary shutdown. <a href="#a1"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a2">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"> </td><td class="mdescRight">Standard startup and shutdown (port library allocated on stack or by application). <a href="#a2"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a3">hyport_startup_library</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">PortLibrary startup. <a href="#a3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a4">hyport_getSize</a> (struct HyPortLibraryVersion *version)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the size of the port library. <a href="#a4"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a5">hyport_getVersion</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, struct HyPortLibraryVersion *version)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the version of the port library. <a href="#a5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a6">hyport_isCompatible</a> (struct HyPortLibraryVersion *expectedVersion)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine port library compatibility. <a href="#a6"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a7">hyport_isFunctionOverridden</a> (struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, UDATA offset)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the port library. <a href="#a7"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">I_32 VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a8">hyport_allocate_library</a> (struct HyPortLibraryVersion *version, struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> **portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Port library self allocation routines. <a href="#a8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hyport_8c.html#a9">initNLSCatalog</a> (<a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLib)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the NLS catalog (must be done prior to any NLS usage). <a href="#a9"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a8"></a><!-- doxytag: member="hyport.c::hyport_allocate_library" ref="a8" args="(struct HyPortLibraryVersion *version, struct HyPortLibrary **portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_allocate_library </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct HyPortLibraryVersion * </td>
+ <td class="mdname" nowrap> <em>version</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> ** </td>
+ <td class="mdname" nowrap> <em>portLibrary</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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#a443">hyport_startup_library</a>) allowing the application to override any functions they desire. In the event <a class="el" href="hyport_8h.html#a443">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> </td><td valign="top"><em>version</em> </td><td>The required version of the port library. </td></tr>
+ <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>portLibrary</em> </td><td>Pointer to the allocated port library table.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure</dd></dl>
+<dl 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#a442">hyport_shutdown_library</a> will deallocate this memory as part of regular shutdown</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a2"></a><!-- doxytag: member="hyport.c::hyport_create_library" ref="a2" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_create_library </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>struct HyPortLibraryVersion * </td>
+ <td class="mdname" nowrap> <em>version</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>size</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>version</em> </td><td>The required version of the port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the port library.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure </dd></dl>
+<dl compact><dt><b>Note:</b></dt><dd>The portlibrary version must be compatabile with the that which we are compiled against</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a4"></a><!-- doxytag: member="hyport.c::hyport_getSize" ref="a4" args="(struct HyPortLibraryVersion *version)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">UDATA VMCALL hyport_getSize </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct HyPortLibraryVersion * </td>
+ <td class="mdname1" valign="top" nowrap> <em>version</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>version</em> </td><td>The HyPortLibraryVersion structure.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>size of port library on success, zero on failure</dd></dl>
+<dl compact><dt><b>Note:</b></dt><dd>The portlibrary version must be compatabile with the that which we are compiled against</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a5"></a><!-- doxytag: member="hyport.c::hyport_getVersion" ref="a5" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_getVersion </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>struct HyPortLibraryVersion * </td>
+ <td class="mdname" nowrap> <em>version</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library. </td></tr>
+ <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>version</em> </td><td>The HyPortLibraryVersion structure to be populated.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure </dd></dl>
+<dl compact><dt><b>Note:</b></dt><dd>If portLibrary is NULL, version is populated with the version in the linked DLL</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a0"></a><!-- doxytag: member="hyport.c::hyport_init_library" ref="a0" args="(struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_init_library </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>struct HyPortLibraryVersion * </td>
+ <td class="mdname" nowrap> <em>version</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>size</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>version</em> </td><td>The required version of the port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the port library.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, negative return value on failure</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a6"></a><!-- doxytag: member="hyport.c::hyport_isCompatible" ref="a6" args="(struct HyPortLibraryVersion *expectedVersion)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_isCompatible </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct HyPortLibraryVersion * </td>
+ <td class="mdname1" valign="top" nowrap> <em>expectedVersion</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>expectedVersion</em> </td><td>The version the application requires as a minimum.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>1 if compatible, 0 if not compatible</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a7"></a><!-- doxytag: member="hyport.c::hyport_isFunctionOverridden" ref="a7" args="(struct HyPortLibrary *portLibrary, UDATA offset)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_isFunctionOverridden </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>offset</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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> </td><td valign="top"><em>portLibrary</em> </td><td>The port library. </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>offset</em> </td><td>The offset of the function to be queried.</td></tr>
+ </table>
+</dl>
+<dl 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)); </td>
+ </tr>
+</table>
+<a class="anchor" name="a1"></a><!-- doxytag: member="hyport.c::hyport_shutdown_library" ref="a1" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_shutdown_library </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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#a443">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> </td><td valign="top"><em>portLibrary</em> </td><td>The portlibrary.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success, negative return code on failure</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a3"></a><!-- doxytag: member="hyport.c::hyport_startup_library" ref="a3" args="(struct HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">I_32 VMCALL hyport_startup_library </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">struct <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLibrary</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<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#a442">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> </td><td valign="top"><em>portLibrary</em> </td><td>The portlibrary.</td></tr>
+ </table>
+</dl>
+<dl 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 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#a444">hyport_allocate_library</a></dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a9"></a><!-- doxytag: member="hyport.c::initNLSCatalog" ref="a9" args="(HyPortLibrary *portLib)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void initNLSCatalog </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname1" valign="top" nowrap> <em>portLib</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Initialize the NLS catalog (must be done prior to any NLS usage).
+<p>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>