diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2003-10-20 22:23:33 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2003-10-20 22:23:33 (GMT) |
commit | bbdf1c5de338ffe5644fd6e1e690876c73a3653b (patch) | |
tree | 1f08f96fa08e19645f3708e92921a59cbb1c6e16 | |
parent | 75d4f35593d119b95b0e231ffa161132d28e0128 (diff) | |
download | hdf5-bbdf1c5de338ffe5644fd6e1e690876c73a3653b.zip hdf5-bbdf1c5de338ffe5644fd6e1e690876c73a3653b.tar.gz hdf5-bbdf1c5de338ffe5644fd6e1e690876c73a3653b.tar.bz2 |
[svn-r7680]
Purpose:
Expand H5open/h5open_f and H5close/h5close_f descriptions
to indicate that these two calls are mandatory in Fortran90
applications (though optional in C).
Platforms tested:
IE 5, Safari
-rw-r--r-- | doc/html/RM_H5.html | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index a16e52d..e90e2d2 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -284,9 +284,12 @@ END SUBROUTINE h5check_version_f <dd><code>H5close</code> flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library. This function is generally called when the - application calls <code>exit</code>, but may be called earlier + application calls <code>exit()</code>, but may be called earlier in event of an emergency shutdown or out of desire to free all resources used by the HDF5 library. + <p> + <code>h5close_f</code> and <code>h5open_f</code> are + required calls in Fortran90 applications. <dt><strong>Parameters:</strong> <dl> <dt>None. @@ -467,10 +470,23 @@ END SUBROUTINE h5get_libversion_f <dt><strong>Purpose:</strong> <dd>Initializes the HDF5 library. <dt><strong>Description:</strong> - <dd><code>H5open</code> 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. + <dd><code>H5open</code> initialize the library. + <p> + When the HDF5 Library is employed in a C application, + this function is normally called automatically, but if you + find that an HDF5 library function is failing inexplicably, + try calling this function first. + If you wish to elimnate this possibility, it is safe to + routinely call <code>H5open</code> before an application + starts working with the library as there are no damaging + side-effects in calling it more than once. + <p> + When the HDF5 Library is employed in a Fortran90 application, + <code>h5open_f</code> initializes global variables + (e.g. predefined types) and performs other tasks required to + initialize the library. + <code>h5open_f</code> and <code>h5close_f</code> are therefore + required calls in Fortran90 applications. <dt><strong>Parameters:</strong> <dl> <dt>None. @@ -615,7 +631,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 10 October 2003"); +document.writeln("Last modified: 20 October 2003"); --> </SCRIPT> |