philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r4271] Purpose:

Browse Source 
Revised the section of H5check_version().
Platforms tested:
    IE 5 displayed.
This commit is contained in:
Albert Cheng
2001-07-30 03:35:45 -05:00
parent b892ecdbf9
commit 162e324e82
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/html/RM_H5.html
View File

@@ -300,7 +300,8 @@ facilitate moving easily between them.</i>
<p>
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.
matches the version of the HDF5 library being used. One may look at
the H5check() definition in H5public.h as an example.
<p>
Due to the risks of data corruption or segmentation faults,
<code>H5check_version</code> causes the application to abort if the
@@ -310,22 +311,24 @@ facilitate moving easily between them.</i>
<p>
Note that <code>H5check_version</code> verifies only the
major and minor version numbers and the release number;
it does not verify the sub-release number as that should be
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.)
<p>
<!--
Secondarily, <code>H5check_version</code> verifies that the
library version identifiers <code>H5_VERS_MAJOR</code>,
<code>H5_VERS_MINOR</code>, <code>H5_VERS_RELEASE</code>,
<code>H5_VERS_SUBRELEASE</code>, and <code>H5_VERS_INFO</code>
are consistent.
This is designed to catch source code inconsistencies,
but does not generate the fatal error
that is generated by a failure in the first stage.
but does not generate the fatal error as in the first stage
because this inconsistency does not cause errors in the data files.
<p>
<!--
<strong><em>Alternate to preceding paragraph / More to the point?</em></strong>
<br>
-->
If the function passes the above test and does not generate
an <code>abort()</code> call, the function's second purpose
comes into play.
@@ -349,6 +352,7 @@ facilitate moving easily between them.</i>
the 1 is the major version number, <code>majnum</code>;
the 1 is the minor version number, <code>minnum</code>; and
the 1 is the release number, <code>relnum</code>.
-->
<dt><strong>Parameters:</strong>
<dl>
<dt><em>unsigned </em><code>majnum</code>