diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1998-09-10 15:40:15 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1998-09-10 15:40:15 (GMT) |
commit | 750856c53aa1cae3217e853ab7571b20bc658ffc (patch) | |
tree | 2ad244b7c01b98180e29883c74c87d4262ac1c62 /doc/src/RM_H5.html | |
parent | d07894304f4a608af828aee0a99dbb875fba1fa1 (diff) | |
download | hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.zip hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.gz hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.bz2 |
[svn-r684] RM_H5Front.html
Added link to Tools.html
Clean up formatting.
Added RM_H5R.html, Ragged Arrays, but link is commented out for Beta.
RM_H5.html
H5version Removed patch number parameter.
H5check_version Removed patch number parameter.
Corrected datatype to unsigned (was unsigned *).
Added missing "Purpose:" statement.
RM_H5A.html
H5Aread/write Added reference to data conversion limitations.
RM_H5D.html
H5Dwrite Added "Writing to an external dataset will fail
if the HDF5 file is not open for writing."
H5Dread/write Added reference to data conversion limitations.
RM_H5F.html
H5Fflush Added H5Fflush.
RM_H5G.html
H5Gget_stat Fixed formatting error.
Added mtime to the description of the data structure.
Added the following "Note:", per Robb's checkin mesage:
"Some systems will be able to record the time
accurately but unable to retrieve the correct time;
such systems (e.g., Irix64) will report an mtime
value of 0 (zero)."
Corrected successful return value.
H5Gset_comment Added the following statement to "Description:"
"Comments can be attached to any object that
has an object header, e.g., data sets, groups,
named data types, and data spaces,
but not symbolic links.
RM_H5P.html
Cleaned up file formatting.
H5Pset_filter Added these three functions.
H5Pget_nfilters
H5Pget_filter
H5Pget_deflate Removed these three functions. (Actually,
H5Pset_compression they are commented out, in case they should
H5Pget_compression be reinstated.)
RM_H5R.html
Intial version of H5R reference manual entry, but still largely
just a template.
Not yet ready for distribution.
Links to this document are currently commented out.
RM_H5S.html
H5S_set_extent_simple Changed name to H5Sselect_extent_simple.
now: H5Sselect_extent_simpl
H5Sselect_npoints Corrected return value.
Now: H5Sget_select_npoints
H5Sget_class Reinstated to RM. Changed name.
now: H5Sget_space_type
H5Soffset_simple Added these 6 functions. The there is a
H5Sextent_copy link to Dataspaces.html for the 10 "not yet
H5Sset_extent_none implemented (NYI)" functions.
H5Sselect_all
H5Sselect_none
H5Sselect_valid
RM_H5T.html
Added the following datatypes (though the list of native datatypes
is commented out):
H5T_NATIVE_HSIZE
H5T_NATIVE_HSSIZE
H5T_NATIVE_HERR
H5T_NATIVE_HBOOL
Tools.html
Corrected h5ls and h5repart sections.
Glossary.html
Unlinked for Beta.
Copyright.html
New file.
Copyright statement, linked into User's Guide and Reference Manual.
General
Changed the following function names:
From: To:
H5version H5get_libversion
H5vers_check H5check_version
H5Anum_attrs H5Aget_num_attrs
H5Fget_create_template H5Fget_create_plist
H5Fget_access_template H5Fget_access_plist
And associated "template" -> "property list" edits.
H5Gstat H5Gget_stat
H5Sextent_npoints H5Sget_simple_extent_npoints
H5Sextent_ndims H5Sget_simple_extent_ndims
H5Sextent_dims H5Sget_simple_extent_dims
H5Sget_class H5Sget_simple_extent_type
H5Sselect_npoints H5Sget_select_npoints
Added links to Tools.html and RM_H5R.html (Ragged Arrays),
though link to RM_H5R.html is commented out for now.
Diffstat (limited to 'doc/src/RM_H5.html')
-rwxr-xr-x | doc/src/RM_H5.html | 41 |
1 files changed, 22 insertions, 19 deletions
diff --git a/doc/src/RM_H5.html b/doc/src/RM_H5.html index 8b2ab70..ad2cb8d 100755 --- a/doc/src/RM_H5.html +++ b/doc/src/RM_H5.html @@ -18,7 +18,10 @@ H5 <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -37,8 +40,8 @@ and it users. </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Library-Version">H5version</a> - <li><a href="#Library-VersCheck">H5vers_check</a> + <li><a href="#Library-Version">H5get_libversion</a> + <li><a href="#Library-VersCheck">H5check_version</a> </ul> </td><td> </td><td valign=top> <ul> @@ -127,18 +130,18 @@ and it users. <hr> <dl> -<dt><strong>Name:</strong> <a name="Library-Version">H5version</a> +<dt><strong>Name:</strong> <a name="Library-Version">H5get_libversion</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5version</code>(<em>unsigned *</em><code>majnum</code>, + <dd><em>herr_t</em> <code>H5get_libversion</code>(<em>unsigned *</em><code>majnum</code>, <em>unsigned *</em><code>minnum</code>, - <em>unsigned *</em><code>relnum</code>, - <em>unsigned *</em><code>patnum</code> + <em>unsigned *</em><code>relnum</code> ) <dt><strong>Purpose:</strong> - <dd> + <dd>Returns the HDF library release number. <dt><strong>Description:</strong> - <dd><code>H5version</code> retrieves the major, minor, release, and - patch versions of the library which is linked to the application. + <dd><code>H5get_libversion</code> retrieves the major, minor, and release + numbers of the version of the HDF library which is linked to + the application. <dt><strong>Parameters:</strong> <dl> <dt><em>unsigned *</em><code>majnum</code> @@ -147,8 +150,6 @@ and it users. <dd>The minor version of the library. <dt><em>unsigned *</em><code>relnum</code> <dd>The release number of the library. - <dt><em>unsigned *</em><code>patnum</code> - <dd>The patch number of the library. </dl> <dt><strong>Returns:</strong> <dd>Returns SUCCEED (0) if successful; @@ -158,23 +159,22 @@ and it users. <hr> <dl> -<dt><strong>Name:</strong> <a name="Library-VersCheck">H5vers_check</a> +<dt><strong>Name:</strong> <a name="Library-VersCheck">H5check_version</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5vers_check</code>(<em>unsigned *</em><code>majnum</code>, - <em>unsigned *</em><code>minnum</code>, - <em>unsigned *</em><code>relnum</code>, - <em>unsigned *</em><code>patnum</code> + <dd><em>herr_t</em> <code>H5check_version</code>(<em>unsigned</em> <code>majnum</code>, + <em>unsigned</em> <code>minnum</code>, + <em>unsigned</em> <code>relnum</code> ) <dt><strong>Purpose:</strong> <dd> <dt><strong>Description:</strong> - <dd><code>H5vers_check</code> verifies that the arguments match the + <dd><code>H5check_version</code> verifies that the arguments match the version numbers compiled into the library. This function is intended to be called from user to verify that the versions of header files compiled into the application match the version of the HDF5 library. <p> Due to the risks of data corruption or segmentation faults, - <code>H5vers_check</code> causes the application to abort if the + <code>H5check_version</code> causes the application to abort if the version numbers do not match. <dt><strong>Parameters:</strong> <dl> @@ -206,7 +206,10 @@ H5 <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -214,7 +217,7 @@ H5 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 2 September 1998 </body> </html> |