From harmony-commits-return-306-apmail-incubator-harmony-commits-archive=incubator.apache.org@incubator.apache.org Thu Dec 01 06:20:18 2005 Return-Path: Delivered-To: apmail-incubator-harmony-commits-archive@www.apache.org Received: (qmail 49059 invoked from network); 1 Dec 2005 06:20:16 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 1 Dec 2005 06:20:16 -0000 Received: (qmail 2625 invoked by uid 500); 1 Dec 2005 06:16:49 -0000 Delivered-To: apmail-incubator-harmony-commits-archive@incubator.apache.org Received: (qmail 589 invoked by uid 500); 1 Dec 2005 06:15:47 -0000 Mailing-List: contact harmony-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: harmony-dev@incubator.apache.org Delivered-To: mailing list harmony-commits@incubator.apache.org Received: (qmail 98762 invoked by uid 99); 1 Dec 2005 06:13:50 -0000 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Wed, 30 Nov 2005 22:11:22 -0800 Received: (qmail 43613 invoked by uid 65534); 1 Dec 2005 06:10:58 -0000 Message-ID: <20051201061058.43612.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: 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... Date: Thu, 01 Dec 2005 06:04:00 -0000 To: harmony-commits@incubator.apache.org From: geirm@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N 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 @@ + + +Harmony Class Library Porting: native-src/win.IA32/port/hynls.c File Reference + + + + + +

hynls.c File Reference


Detailed Description

+Native language support. +

+ +

+#include "hycomp.h"
+#include "hyport.h"
+#include "portpriv.h"
+#include "hythread.h"
+#include "hynlshelpers.h"
+#include "portnls.h"
+#include <stdlib.h>
+#include <string.h>
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

void VMCALL hynls_set_locale (struct HyPortLibrary *portLibrary, const char *lang, const char *region, const char *variant)
 Set the language, region, and variant of the locale.
const char *VMCALL hynls_get_language (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set language.
const char *VMCALL hynls_get_region (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set region.
const char *VMCALL hynls_get_variant (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set variant.
void VMCALL hynls_printf (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num,...)
 Print a formatted NLS message.
void VMCALL hynls_vprintf (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, va_list args)
 Print a formatted NLS message.
const char *VMCALL hynls_lookup_message (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, const char *default_string)
 Return the NLS string for the module name and message number.
void VMCALL hynls_set_catalog (struct HyPortLibrary *portLibrary, const char **paths, const int nPaths, const char *baseName, const char *extension)
 Setup the path to the NLS catalog.
I_32 VMCALL hynls_startup (struct HyPortLibrary *portLibrary)
 PortLibrary startup.
void VMCALL hynls_shutdown (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
+


Function Documentation

+

+ + + + +
+ + + + + + + + + +
const char* VMCALL hynls_get_language struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+Return the string representing the currently set language. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
language string
+
+

+ + + + +
+ + + + + + + + + +
const char* VMCALL hynls_get_region struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+Return the string representing the currently set region. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
region string
+
+

+ + + + +
+ + + + + + + + + +
const char* VMCALL hynls_get_variant struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+Return the string representing the currently set variant. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
variant string
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const char* VMCALL hynls_lookup_message struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
const char *  default_string
+
+ + + + + +
+   + + +

+Return the NLS string for the module name and message number. +

+If no string is found, or a failure occurs, return the default_string.

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] default_string - a default message, in case no NLS message is found
+
+
Returns:
NLS String
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_printf struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
  ...
+
+ + + + + +
+   + + +

+Print a formatted NLS message. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] ... - arguments used in the NLS message format
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_set_catalog struct HyPortLibrary portLibrary,
const char **  paths,
const int  nPaths,
const char *  baseName,
const char *  extension
+
+ + + + + +
+   + + +

+Setup the path to the NLS catalog. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] paths - an array of directory paths where the NLS catalog may be found
[in] nPaths - the number of entries in the paths array
[in] baseName - the lead name of the catalog file name (i.e., the "java" in java_en_US.properties)
[in] extension - the extension of the catalog file name (i.e., the "properties in java_en_US.properties)
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_set_locale struct HyPortLibrary portLibrary,
const char *  lang,
const char *  region,
const char *  variant
+
+ + + + + +
+   + + +

+Set the language, region, and variant of the locale. +

+

Parameters:
+ + + + + +
[in] portLibrary The port library
[in] lang - the language of the locale (e.g., "en"), 2 characters or less
[in] region - the region of the locale (e.g., "US"), 2 characters or less
[in] variant - the variant of the locale (e.g., "boont"), 31 characters or less
+
+
+

+ + + + +
+ + + + + + + + + +
void VMCALL hynls_shutdown struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+PortLibrary shutdown. +

+This function is called during shutdown of the portLibrary. Any resources that were created by hynls_startup should be destroyed here.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
+

+ + + + +
+ + + + + + + + + +
I_32 VMCALL hynls_startup struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+PortLibrary startup. +

+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 hynls_shutdown.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_NLS
  • +
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_vprintf struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
va_list  args
+
+ + + + + +
+   + + +

+Print a formatted NLS message. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] args - arguments used in the NLS message format
+
+
+


+
+ + (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable. + +
+ + 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 @@ + + +Harmony Class Library Porting: native-src/win.IA32/port/hyosdump.c File Reference + + + + + +

hyosdump.c File Reference


Detailed Description

+Dump formatting. +

+ +

+#include <windows.h>
+#include <winnt.h>
+#include <stdlib.h>
+#include <float.h>
+#include <process.h>
+#include <dbghelp.h>
+#include "hyport.h"
+#include "hysignal.h"
+ + + + + + +

Functions

UDATA VMCALL hydump_create (struct HyPortLibrary *portLibrary, char *filename, char *dumpType, void *userData)
 Create a dump file of the OS state.
+


Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UDATA VMCALL hydump_create struct HyPortLibrary portLibrary,
char *  filename,
char *  dumpType,
void *  userData
+
+ + + + + +
+   + + +

+Create a dump file of the OS state. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library.
[in] filename Buffer for filename optionally containing the filename where dump is to be output.
[out] filename filename used for dump file or error message.
[in] dumpType Type of dump to perform.
[in] userData Implementation specific data.
+
+
Returns:
0 on success, non-zero otherwise.
+
Note:
filename buffer can not be NULL.

+user allocates and frees filename buffer.

+filename buffer length is platform dependent, assumed to be HyMaxPath/MAX_PATH

+if filename buffer is empty, a filename will be generated.

+if HYUNIQUE_DUMPS is set, filename will be unique.

+
+


+
+ + (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable. + +
+ + 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 @@ + + +Harmony Class Library Porting: native-src/win.IA32/include/hypool.h File Reference + + + + + +

hypool.h File Reference


Detailed Description

+Pool Header. +

+ +

+#include "hycomp.h"
+#include "hyport.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  HyPool
struct  HyPoolState

Functions

HY_CFUNC void VMCALL pool_do (HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)
 Calls a user provided function for each element in the list.
HY_CFUNC void VMCALL pool_removeElement (HyPool *aPool, void *anElement)
 Deallocates an element from a pool.
HY_CFUNC UDATA VMCALL pool_numElements (HyPool *aPool)
 Returns the number of elements in a given pool.
HY_CFUNC void *VMCALL pool_newElement (HyPool *aPool)
 Asks for the address of a new pool element.
HY_CFUNC HyPool *VMCALL pool_forPortLib (U_32 structSize, HyPortLibrary *portLibrary)
 Shortcut for pool_new, using the default malloc/free from the portLibrary.
HY_CFUNC void VMCALL pool_kill (HyPool *aPool)
 Deallocates all memory associated with a pool.
HY_CFUNC void VMCALL pool_sortFree (HyPool *aPool)
 Sorts the free list of the current pool.
HY_CFUNC void VMCALL pool_clear (HyPool *aPool)
 Clear the contents of a pool but not delete it.
HY_CFUNC UDATA VMCALL pool_capacity (HyPool *aPool)
 Returns the total capacity of a pool.
HY_CFUNC UDATA VMCALL pool_ensureCapacity (HyPool *aPool, UDATA newCapacity)
 Ensures that the pool is large enough for newCapacity elements.
+


Function Documentation

+

+ + + + +
+ + + + + + + + + +
HY_CFUNC UDATA VMCALL pool_capacity HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Returns the total capacity of a pool. +

+

Parameters:
+ + +
[in] aPool The pool
+
+
Returns:
0 on error

+numElements in aPool otherwise

+
+

+ + + + +
+ + + + + + + + + +
HY_CFUNC void VMCALL pool_clear HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Clear the contents of a pool but not delete it. +

+

Note:
Make no assumptions about the contents of the pool after invoking this method (it currently does not zero the memory)
+
Parameters:
+ + +
[in] aPool The pool to clear
+
+
Returns:
none
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
HY_CFUNC void VMCALL pool_do HyPool *  aPool,
void(*)(void *anElement, void *userData)  aFunction,
void *  userData
+
+ + + + + +
+   + + +

+Calls a user provided function for each element in the list. +

+

Parameters:
+ + + + +
[in] aPool The pool to "do" things to
[in] aFunction Pointer to function which will "do" things to the elements of aPool
[in] userData Pointer to data to be passed to "do" function, along with each pool-element
+
+
Returns:
none
+
See also:
pool_startDo, pool_nextDo
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
HY_CFUNC UDATA VMCALL pool_ensureCapacity HyPool *  aPool,
UDATA  newCapacity
+
+ + + + + +
+   + + +

+Ensures that the pool is large enough for newCapacity elements. +

+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.

+

Parameters:
+ + + +
[in] aPool The pool
[in] newCapacity The desired new-size of the pool
+
+
Returns:
0 on success

+-1 on failure

+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
HY_CFUNC HyPool* VMCALL pool_forPortLib U_32  structSize,
HyPortLibrary portLibrary
+
+ + + + + +
+   + + +

+Shortcut for pool_new, using the default malloc/free from the portLibrary. +

+

Parameters:
+ + + +
[in] structSize size of pool-element
[in] portLibrary 
+
+
Returns:
pointer to a Pool
+
See also:
pool_new
+
+

+ + + + +
+ + + + + + + + + +
HY_CFUNC void VMCALL pool_kill HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Deallocates all memory associated with a pool. +

+

Parameters:
+ + +
[in] aPool Pool to be deallocated
+
+
Returns:
none
+
+

+ + + + +
+ + + + + + + + + +
HY_CFUNC void* VMCALL pool_newElement HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Asks for the address of a new pool element. +

+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.

+

Parameters:
+ + +
[in] aPool 
+
+
Returns:
NULL on error

+pointer to a new element otherwise

+
+

+ + + + +
+ + + + + + + + + +
HY_CFUNC UDATA VMCALL pool_numElements HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Returns the number of elements in a given pool. +

+

Parameters:
+ + +
[in] aPool 
+
+
Returns:
0 on error

+the number of elements in the pool otherwise

+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
HY_CFUNC void VMCALL pool_removeElement HyPool *  aPool,
void *  anElement
+
+ + + + + +
+   + + +

+Deallocates an element from a pool. +

+It is safe to call pool_removeElement() while looping over the pool with pool_startDo / pool_nextDo 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.

+

Parameters:
+ + + +
[in] aPool 
[in] anElement Pointer to the element to be removed
+
+
Returns:
none
+
+

+ + + + +
+ + + + + + + + + +
HY_CFUNC void VMCALL pool_sortFree HyPool *  aPool  ) 
+
+ + + + + +
+   + + +

+Sorts the free list of the current pool. +

+(ie: does not follow nextPool pointers...) This is a O(n) most of the time.

+

Parameters:
+ + +
[in] aPool The pool to be sorted
+
+
Returns:
none
+
+


+
+ + (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable. + +
+ + 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 @@ + + +Harmony Class Library Porting: native-src/win.IA32/port/hyport.c File Reference + + + + + +

hyport.c File Reference


Detailed Description

+Port Library. +

+ +

+#include <string.h>
+#include "hyport.h"
+#include "portpriv.h"
+#include "hyportpg.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

I_32 VMCALL hyport_init_library (struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)
 Initialize the port library.
I_32 VMCALL hyport_shutdown_library (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
I_32 VMCALL hyport_create_library (struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version, UDATA size)
 Standard startup and shutdown (port library allocated on stack or by application).
I_32 VMCALL hyport_startup_library (struct HyPortLibrary *portLibrary)
 PortLibrary startup.
UDATA VMCALL hyport_getSize (struct HyPortLibraryVersion *version)
 Determine the size of the port library.
I_32 VMCALL hyport_getVersion (struct HyPortLibrary *portLibrary, struct HyPortLibraryVersion *version)
 Determine the version of the port library.
I_32 VMCALL hyport_isCompatible (struct HyPortLibraryVersion *expectedVersion)
 Determine port library compatibility.
I_32 VMCALL hyport_isFunctionOverridden (struct HyPortLibrary *portLibrary, UDATA offset)
 Query the port library.
I_32 VMCALL hyport_allocate_library (struct HyPortLibraryVersion *version, struct HyPortLibrary **portLibrary)
 Port library self allocation routines.
void initNLSCatalog (HyPortLibrary *portLib)
 Initialize the NLS catalog (must be done prior to any NLS usage).
+


Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyport_allocate_library struct HyPortLibraryVersion *  version,
struct HyPortLibrary **  portLibrary
+
+ + + + + +
+   + + +

+Port library self allocation routines. +

+Given a pointer to the required version of the port library allocate and initialize the structure. The startup function is not called (hyport_startup_library) allowing the application to override any functions they desire. In the event hyport_startup_library fails when called by the application the port library memory will be freed.

+

Parameters:
+ + + +
[in] version The required version of the port library.
[out] portLibrary Pointer to the allocated port library table.
+
+
Returns:
0 on success, negative return value on failure
+
Note:
portLibrary will be NULL on failure

+The portlibrary version must be compatabile with the that which we are compiled against

+hyport_shutdown_library will deallocate this memory as part of regular shutdown

+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyport_create_library struct HyPortLibrary portLibrary,
struct HyPortLibraryVersion *  version,
UDATA  size
+
+ + + + + +
+   + + +

+Standard startup and shutdown (port library allocated on stack or by application). +

+Given a pointer to a port library and the required version, populate the port library table with the appropriate functions

+

Parameters:
+ + + + +
[in] portLibrary The port library.
[in] version The required version of the port library.
[in] size Size of the port library.
+
+
Returns:
0 on success, negative return value on failure
+
Note:
The portlibrary version must be compatabile with the that which we are compiled against
+
+

+ + + + +
+ + + + + + + + + +
UDATA VMCALL hyport_getSize struct HyPortLibraryVersion *  version  ) 
+
+ + + + + +
+   + + +

+Determine the size of the port library. +

+Given a port library version, return the size of the structure in bytes required to be allocated.

+

Parameters:
+ + +
[in] version The HyPortLibraryVersion structure.
+
+
Returns:
size of port library on success, zero on failure
+
Note:
The portlibrary version must be compatabile with the that which we are compiled against
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyport_getVersion struct HyPortLibrary portLibrary,
struct HyPortLibraryVersion *  version
+
+ + + + + +
+   + + +

+Determine the version of the port library. +

+Given a port library return the version of that instance.

+

Parameters:
+ + + +
[in] portLibrary The port library.
[in,out] version The HyPortLibraryVersion structure to be populated.
+
+
Returns:
0 on success, negative return value on failure
+
Note:
If portLibrary is NULL, version is populated with the version in the linked DLL
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyport_init_library struct HyPortLibrary portLibrary,
struct HyPortLibraryVersion *  version,
UDATA  size
+
+ + + + + +
+   + + +

+Initialize the port library. +

+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.

+

Parameters:
+ + + + +
[in] portLibrary The port library.
[in] version The required version of the port library.
[in] size Size of the port library.
+
+
Returns:
0 on success, negative return value on failure
+
+

+ + + + +
+ + + + + + + + + +
I_32 VMCALL hyport_isCompatible struct HyPortLibraryVersion *  expectedVersion  ) 
+
+ + + + + +
+   + + +

+Determine port library compatibility. +

+Given the minimum version of the port library that the application requires determine if the current port library meets that requirements.

+

Parameters:
+ + +
[in] expectedVersion The version the application requires as a minimum.
+
+
Returns:
1 if compatible, 0 if not compatible
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyport_isFunctionOverridden struct HyPortLibrary portLibrary,
UDATA  offset
+
+ + + + + +
+   + + +

+Query the port library. +

+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.

+

Parameters:
+ + + +
[in] portLibrary The port library.
[in] offset The offset of the function to be queried.
+
+
Returns:
1 if the function is overriden, else 0.
+hyport_isFunctionOverridden(portLibrary, offsetof(HyPortLibrary, mem_allocate_memory));
+

+ + + + +
+ + + + + + + + + +
I_32 VMCALL hyport_shutdown_library struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+PortLibrary shutdown. +

+Shutdown the port library, de-allocate resources required by the components of the portlibrary. Any resources that werer created by hyport_startup_library should be destroyed here.

+

Parameters:
+ + +
[in] portLibrary The portlibrary.
+
+
Returns:
0 on success, negative return code on failure
+
+

+ + + + +
+ + + + + + + + + +
I_32 VMCALL hyport_startup_library struct HyPortLibrary portLibrary  ) 
+
+ + + + + +
+   + + +

+PortLibrary startup. +

+Start the port library, allocate resources required by the components of the portlibrary. All resources created here should be destroyed in hyport_shutdown_library.

+

Parameters:
+ + +
[in] portLibrary The portlibrary.
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_THREAD
  • +
  • HYPORT_ERROR_STARTUP_MEM
  • +
  • HYPORT_ERROR_STARTUP_TLS
  • +
  • HYPORT_ERROR_STARTUP_TLS_ALLOC
  • +
  • HYPORT_ERROR_STARTUP_TLS_MUTEX
  • +
  • HYPORT_ERROR_STARTUP_ERROR
  • +
  • HYPORT_ERROR_STARTUP_CPU
  • +
  • HYPORT_ERROR_STARTUP_VMEM
  • +
  • HYPORT_ERROR_STARTUP_FILE
  • +
  • HYPORT_ERROR_STARTUP_TTY
  • +
  • HYPORT_ERROR_STARTUP_TTY_HANDLE
  • +
  • HYPORT_ERROR_STARTUP_TTY_CONSOLE
  • +
  • HYPORT_ERROR_STARTUP_MMAP
  • +
  • HYPORT_ERROR_STARTUP_IPCMUTEX
  • +
  • HYPORT_ERROR_STARTUP_NLS
  • +
  • HYPORT_ERROR_STARTUP_SOCK
  • +
  • HYPORT_ERROR_STARTUP_TIME
  • +
  • HYPORT_ERROR_STARTUP_GP
  • +
  • HYPORT_ERROR_STARTUP_EXIT
  • +
  • HYPORT_ERROR_STARTUP_SYSINFO
  • +
  • HYPORT_ERROR_STARTUP_SL
  • +
  • HYPORT_ERROR_STARTUP_STR
  • +
  • HYPORT_ERROR_STARTUP_SHSEM
  • +
  • HYPORT_ERROR_STARTUP_SHMEM
  • +
  • HYPORT_ERROR_STARTUP_SIGNAL
  • +
+
+
Note:
The port library memory is deallocated if it was created by hyport_allocate_library
+
+

+ + + + +
+ + + + + + + + + +
void initNLSCatalog HyPortLibrary portLib  ) 
+
+ + + + + +
+   + + +

+Initialize the NLS catalog (must be done prior to any NLS usage). +

+

+


+
+ + (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable. + +
+ +