From 5956fb63812e9156af8549f31fef9e3e6a93c5bd Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 7 Oct 2003 14:18:32 -0500 Subject: [svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari --- doc/html/RM_H5.html | 406 +++++++++++++++++++++++++++------------------------- 1 file changed, 212 insertions(+), 194 deletions(-) diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 95e5598..2c770e7 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -60,8 +60,7 @@ And in this document, the -
-
+

H5: General Library Functions

@@ -96,29 +95,36 @@ and it users. +
+        +        +
-

+
The FORTRAN90 Interfaces:
@@ -132,6 +138,7 @@ information. You will probably want to adjust the size and location of this external window so that both browser windows are visible and to facilitate moving easily between them. +
@@ -153,28 +160,98 @@ facilitate moving easily between them.
- + + +

-
Name: H5open +
Name: H5check_version
Signature: -
herr_t H5open(void) +
herr_t H5check_version(unsigned majnum, + unsigned minnum, + unsigned relnum + )
Purpose: -
Initializes the HDF5 library. +
Verifies that library versions are consistent.
Description: -
H5open initialize the library. This function is - normally called automatically, but if you find that an - HDF5 library function is failing inexplicably, try calling - this function first. +
H5check_version verifies that the arguments provided + with the function call match the version numbers compiled into + the library. +

+ H5check_version serves two slightly differing purposes. +

+ First, the function is intended to be called by the user to verify + that the version of the header files compiled into an application + matches the version of the HDF5 library being used. + One may look at the H5check definition in the file + H5public.h as an example. +

+ Due to the risks of data corruption or segmentation faults, + H5check_version causes the application to abort if the + version numbers do not match. + The abort is achieved by means of a call to the + standard C function abort(). +

+ Note that H5check_version verifies only the + major and minor version numbers and the release number; + it does not verify the sub-release value as that should be + an empty string for any official release. + This means that any two incompatible library versions must + have different {major,minor,release} numbers. (Notice the + reverse is not necessarily true.) +

+ Secondarily, H5check_version verifies that the + library version identifiers H5_VERS_MAJOR, + H5_VERS_MINOR, H5_VERS_RELEASE, + H5_VERS_SUBRELEASE, and H5_VERS_INFO + are consistent. + This is designed to catch source code inconsistencies, + but does not generate the fatal error as in the first stage + because this inconsistency does not cause errors in the data files. + If this check reveals inconsistencies, the library issues a warning + but the function does not fail. +

Parameters:
-
None. +
unsigned majnum +
IN: The major version of the library. +
unsigned minnum +
IN: The minor version of the library. +
unsigned relnum +
IN: The release number of the library.
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns a non-negative value if successful. + Upon failure, this function causes the application to abort.
Non-C API(s): -
- + +
Name: H5close @@ -213,78 +291,47 @@ facilitate moving easily between them. -->
- + +
-
Name: H5set_free_list_limits +
Name: H5dont_atexit
Signature: -
herr_t H5set_free_list_limits(int reg_global_lim, - int reg_list_lim, - int arr_global_lim, - int arr_list_lim, - int blk_global_lim, - int blk_list_lim - ) +
herr_t H5dont_atexit(void)
Purpose: -
Sets free-list size limits. +
Instructs library not to install atexit cleanup routine.
Description: -
H5set_free_list_limits sets size limits - on all types of free lists. - The HDF5 library uses free lists internally to manage memory. - There are three types of free lists: -
  • Regular - free lists manage a single data structure. -
  • Array - free lists manage arrays of a data structure. -
  • Block - free lists manage blocks of bytes. -
- Alternate phrasing?: -
  • Regular - free lists manage data structures containing atomic data. -
  • Array - free lists manage data structures containing array data. -
  • Block - free lists manage blocks of bytes. -
-

- These are global limits, but each limit applies only to - free lists of the specified type. - Therefore, if an application sets a 1Mb limit on each of - the global lists, up to 3Mb of total storage might be - allocated, 1Mb for each of the regular, array, and - block type lists. -

- Using a value of -1 for a limit means that - no limit is set for the specified type of free list. +

H5dont_atexit indicates to the library that an + atexit() cleanup routine should not be installed. + The major purpose for this is in situations where the + library is dynamically linked into an application and is + un-linked from the application before exit() gets + called. In those situations, a routine installed with + atexit() would jump to a routine which was + no longer in memory, causing errors. +

+ In order to be effective, this routine must be called + before any other HDF function calls, and must be called each + time the library is loaded/linked into the application + (the first time and after it's been un-loaded).

Parameters:
-
int reg_global_lim -
IN: The limit on all regular free list memory used -
int reg_list_lim -
IN: The limit on memory used in each regular free list -
int arr_global_lim -
IN: The limit on all array free list memory used -
int arr_list_lim -
IN: The limit on memory used in each array free list -
int blk_global_lim -
IN: The limit on all block free list memory used -
int blk_list_lim -
IN: The limit on memory used in each block free list +
None.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -
-
- + +
Name: H5garbage_collect @@ -322,37 +369,36 @@ facilitate moving easily between them. -->
- + +
-
Name: H5dont_atexit +
Name: H5get_libversion
Signature: -
herr_t H5dont_atexit(void) +
herr_t H5get_libversion(unsigned *majnum, + unsigned *minnum, + unsigned *relnum + )
Purpose: -
Instructs library not to install atexit cleanup routine. +
Returns the HDF library release number.
Description: -
H5dont_atexit indicates to the library that an - atexit() cleanup routine should not be installed. - The major purpose for this is in situations where the - library is dynamically linked into an application and is - un-linked from the application before exit() gets - called. In those situations, a routine installed with - atexit() would jump to a routine which was - no longer in memory, causing errors. -

- In order to be effective, this routine must be called - before any other HDF function calls, and must be called each - time the library is loaded/linked into the application - (the first time and after it's been un-loaded). +

H5get_libversion retrieves the major, minor, and release + numbers of the version of the HDF library which is linked to + the application.
Parameters:
-
None. +
unsigned *majnum +
OUT: The major version of the library. +
unsigned *minnum +
OUT: The minor version of the library. +
unsigned *relnum +
OUT: The release number of the library.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -
- + +
-
Name: H5get_libversion +
Name: H5open
Signature: -
herr_t H5get_libversion(unsigned *majnum, - unsigned *minnum, - unsigned *relnum - ) +
herr_t H5open(void)
Purpose: -
Returns the HDF library release number. +
Initializes the HDF5 library.
Description: -
H5get_libversion retrieves the major, minor, and release - numbers of the version of the HDF library which is linked to - the application. +
H5open initialize the library. This function is + normally called automatically, but if you find that an + HDF5 library function is failing inexplicably, try calling + this function first.
Parameters:
-
unsigned *majnum -
OUT: The major version of the library. -
unsigned *minnum -
OUT: The minor version of the library. -
unsigned *relnum -
OUT: The release number of the library. +
None.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -
+
+ + +
- + +
-
Name: H5check_version +
Name: H5set_free_list_limits
Signature: -
herr_t H5check_version(unsigned majnum, - unsigned minnum, - unsigned relnum - ) +
herr_t H5set_free_list_limits(int reg_global_lim, + int reg_list_lim, + int arr_global_lim, + int arr_list_lim, + int blk_global_lim, + int blk_list_lim + )
Purpose: -
Verifies that library versions are consistent. +
Sets free-list size limits.
Description: -
H5check_version verifies that the arguments provided - with the function call match the version numbers compiled into - the library. -

- H5check_version serves two slightly differing purposes. -

- First, the function is intended to be called by the user to verify - that the version of the header files compiled into an application - matches the version of the HDF5 library being used. - One may look at the H5check definition in the file - H5public.h as an example. -

- Due to the risks of data corruption or segmentation faults, - H5check_version causes the application to abort if the - version numbers do not match. - The abort is achieved by means of a call to the - standard C function abort(). -

- Note that H5check_version verifies only the - major and minor version numbers and the release number; - it does not verify the sub-release value as that should be - an empty string for any official release. - This means that any two incompatible library versions must - have different {major,minor,release} numbers. (Notice the - reverse is not necessarily true.) -

- Secondarily, H5check_version verifies that the - library version identifiers H5_VERS_MAJOR, - H5_VERS_MINOR, H5_VERS_RELEASE, - H5_VERS_SUBRELEASE, and H5_VERS_INFO - are consistent. - This is designed to catch source code inconsistencies, - but does not generate the fatal error as in the first stage - because this inconsistency does not cause errors in the data files. - If this check reveals inconsistencies, the library issues a warning - but the function does not fail. - +

H5set_free_list_limits sets size limits + on all types of free lists. + The HDF5 library uses free lists internally to manage memory. + There are three types of free lists: +
  • Regular + free lists manage a single data structure. +
  • Array + free lists manage arrays of a data structure. +
  • Block + free lists manage blocks of bytes. +
+ Alternate phrasing?: +
  • Regular + free lists manage data structures containing atomic data. +
  • Array + free lists manage data structures containing array data. +
  • Block + free lists manage blocks of bytes. +
+

+ These are global limits, but each limit applies only to + free lists of the specified type. + Therefore, if an application sets a 1Mb limit on each of + the global lists, up to 3Mb of total storage might be + allocated, 1Mb for each of the regular, array, and + block type lists. +

+ Using a value of -1 for a limit means that + no limit is set for the specified type of free list.

Parameters:
-
unsigned majnum -
IN: The major version of the library. -
unsigned minnum -
IN: The minor version of the library. -
unsigned relnum -
IN: The release number of the library. +
int reg_global_lim +
IN: The limit on all regular free list memory used +
int reg_list_lim +
IN: The limit on memory used in each regular free list +
int arr_global_lim +
IN: The limit on all array free list memory used +
int arr_list_lim +
IN: The limit on memory used in each array free list +
int blk_global_lim +
IN: The limit on all block free list memory used +
int blk_list_lim +
IN: The limit on memory used in each block free list
Returns: -
Returns a non-negative value if successful. - Upon failure, this function causes the application to abort. +
Returns a non-negative value if successful; + otherwise returns a negative value.
Non-C API(s): -
- @@ -527,14 +544,15 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.6.0, July 2003 -
- -Last modified: 6 June 2003 +
-- cgit v0.12