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

[svn-r4255]

Browse Source 
Purpose:
    Update
Description:
    Updated H5check_version per Albert's recent expansion of the
    source code comments.
Platforms tested:
    IE 5
This commit is contained in:
Frank Baker
2001-07-24 17:36:42 -05:00
parent 02f66931ea
commit be64a4c2ad
1 changed files with 54 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
doc/html/RM_H5.html
View File

@@ -290,21 +290,65 @@ facilitate moving easily between them.</i>
<em>unsigned</em> <code>relnum</code>
)
<dt><strong>Purpose:</strong>
<dd>
<dd>Verifies that library versions are consistent.
<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 by the user to verify that the version of the header files
compiled into the application matches the version of the HDF5 library
being used.
<dd><code>H5check_version</code> verifies that the arguments provided
with the function call match the version numbers compiled into
the library.
<p>
<code>H5check_version</code> serves two slightly differing purposes.
<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.
<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
The abort is achieved by means of a call to the
standard C function <code>abort()</code>.
<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
an empty string for any official release.
<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.
<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.
<code>H5check_version</code> then procedes to verify
that the additional library version identifiers
<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 under the first function.
<p>
The version and release numbers passed as
<code>H5check_version</code> parameters have the
following relationsips to each other:
<dir>
An official HDF5 release is labelled as
<br>
HDF5 Release &lt;<code>majnum</code>&gt;<strong>.</strong>&lt;<code>minnum</code>&gt;<strong>.</strong>&lt;<code>relnum</code>&gt;
</dir>
For example, in the version of the library known as HDF5 Release 1.4.2,
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>
@@ -369,7 +413,7 @@ H5&nbsp;&nbsp;
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 20 March 2001
Last modified: 24 July 2001
<br>
Describes HDF5 Release 1.4.2, July 2001