summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-12-13 20:39:48 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-12-13 20:39:48 (GMT)
commit658fdbfb981b60eb42a6be70b5e2baf9f01989cd (patch)
tree5da339df5c8e5186fb760c16fcee5bbc0fbbffe3 /doc/html/RM_H5.html
parentca73fde3ba444896894a56dda3dc9f79d06a7bcd (diff)
downloadhdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.zip
hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.gz
hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.bz2
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
Diffstat (limited to 'doc/html/RM_H5.html')
-rw-r--r--doc/html/RM_H5.html28
1 files changed, 15 insertions, 13 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html
index 27c96a3..6457994 100644
--- a/doc/html/RM_H5.html
+++ b/doc/html/RM_H5.html
@@ -162,11 +162,11 @@ and it users.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>unsigned *</em><code>majnum</code>
- <dd>The major version of the library.
+ <dd>OUT: The major version of the library.
<dt><em>unsigned *</em><code>minnum</code>
- <dd>The minor version of the library.
+ <dd>OUT: The minor version of the library.
<dt><em>unsigned *</em><code>relnum</code>
- <dd>The release number of the library.
+ <dd>OUT: The release number of the library.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
@@ -187,22 +187,24 @@ and it users.
<dt><strong>Description:</strong>
<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.
+ to be called by the user to verify that the version of the header files
+ compiled into the application match the version of the HDF5 library being used.
<p>
Due to the risks of data corruption or segmentation faults,
<code>H5check_version</code> causes the application to abort if the
version numbers do not match.
+ <p>
+ If the version numbers of the library do not match
+ the version numbers in the header files being checked, the library calls the
+ standard C function <code>abort()</code>.
<dt><strong>Parameters:</strong>
<dl>
- <dt><em>unsigned *</em><code>majnum</code>
- <dd>The major version of the library.
- <dt><em>unsigned *</em><code>minnum</code>
- <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.
+ <dt><em>unsigned </em><code>majnum</code>
+ <dd>IN: The major version of the library.
+ <dt><em>unsigned </em><code>minnum</code>
+ <dd>IN: The minor version of the library.
+ <dt><em>unsigned </em><code>relnum</code>
+ <dd>IN: The release number of the library.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.