summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2001-03-19 23:26:51 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2001-03-19 23:26:51 (GMT)
commitb03ed1dcec069f42472eef9b132586c93709fafd (patch)
treed90ed2babd44ee86a1f1838bdca68a69c599559b
parentdadeb7e4f888ab199abffe0a72a182a2ac903817 (diff)
downloadhdf5-b03ed1dcec069f42472eef9b132586c93709fafd.zip
hdf5-b03ed1dcec069f42472eef9b132586c93709fafd.tar.gz
hdf5-b03ed1dcec069f42472eef9b132586c93709fafd.tar.bz2
[svn-r3666]
Purpose: Bugfixes and a new description of file-closing behavior. Description: h5.intro.html -- Fixed HTML coding errors. RM_H5.html -- H5close -- Corrected typo. RM_H5F.html -- H5Fclose -- Added paragraph clarifying behavior if any OIDs for contained objects are still open. RM_H5T.html -- H5Tget_strpad -- Corrected description; appears that this did not get updated in synchrony with H5Tset_strpad. H5Tset_strpad -- Corrected 'strpad' parameter description. RM_H5S.html -- H5Sselect_valid -- Corrected description of space_id parameter. RM_H5P.html -- H5Pget_driver -- Corrected return type. Platforms tested: IE 5
-rw-r--r--doc/html/H5.intro.html4
-rw-r--r--doc/html/RM_H5.html2
-rw-r--r--doc/html/RM_H5F.html12
-rw-r--r--doc/html/RM_H5P.html2
-rw-r--r--doc/html/RM_H5S.html3
-rw-r--r--doc/html/RM_H5T.html15
6 files changed, 22 insertions, 16 deletions
diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html
index 82d521e..6ee5f24 100644
--- a/doc/html/H5.intro.html
+++ b/doc/html/H5.intro.html
@@ -2254,7 +2254,7 @@ functions for memory management.
<p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font>
-</FONT><h3><A NAME="Intro-PMCreateArray">Creating array datatypes</A></h3>
+<h3><A NAME="Intro-PMCreateArray">Creating array datatypes</A></h3>
The array class of datatypes, <code>H5T_ARRAY</code>, allows the
construction of true, homogeneous, multi-dimensional arrays.
@@ -2290,7 +2290,7 @@ if the number of dimensions and the sizes of the dimensions are equal
and the datatype of the first array's elements can be converted
to the datatype of the second array's elements.
-<h4>Array datatype APIs</h2>
+<h4>Array datatype APIs</h4>
There are three functions that are specific to array datatypes:
one, <code>H5Tarray_create</code>, for creating an array datatype,
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html
index 22b6777..4a339ed 100644
--- a/doc/html/RM_H5.html
+++ b/doc/html/RM_H5.html
@@ -139,7 +139,7 @@ facilitate moving easily between them.</i>
<dt><strong>Description:</strong>
<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 generall called when the
+ the library. This function is generally called when the
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.
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html
index 6cbd2a8..417ea00 100644
--- a/doc/html/RM_H5F.html
+++ b/doc/html/RM_H5F.html
@@ -444,6 +444,18 @@ facilitate moving easily between them.</i>
(But the file identifier is no longer valid and cannot be used.)
Once all of the remaining access identifiers are closed,
the file will be fully closed and access will end.
+ <p>
+ <strong>EXCEPTION:</strong>
+ Note the following deviation from the above-described behavior.
+ If <code>H5close</code> is called for a file but one or more
+ objects within the file remain open, those objects will remain
+ accessible until they are individually closed.
+ Thus, if the dataset <code>data_sample</code> is open when
+ <code>H5close</code> is called for the file containing it,
+ <code>data_sample</code> will remain open and accessible
+ (including writable) until it is explicitely closed.
+ The file will be automatically closed once all objects in the
+ file have been closed.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>file_id</code>
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html
index 219d395..d747a9f 100644
--- a/doc/html/RM_H5P.html
+++ b/doc/html/RM_H5P.html
@@ -3457,7 +3457,7 @@ facilitate moving easily between them.</i>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDriver">H5Pget_driver</a>
<dt><strong>Signature:</strong>
- <dd><em>hid_t</em> <code>H5Pget_driver</code>(
+ <dd><em>H5F_driver_t</em> <code>H5Pget_driver</code>(
<em>hid_t</em> <code>plist_id</code>
)
<dt><strong>Purpose:</strong>
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html
index 473137b..dbf21e5 100644
--- a/doc/html/RM_H5S.html
+++ b/doc/html/RM_H5S.html
@@ -422,8 +422,7 @@ of the <cite>HDF5 User's Guide.</cite>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>space_id</code>
- <dd>The identifier for the dataspace in which the
- selection is being reset.
+ <dd>The identifier for the dataspace being queried.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a positive value, for <code>TRUE</code>,
diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html
index c54d27f..1a748ad 100644
--- a/doc/html/RM_H5T.html
+++ b/doc/html/RM_H5T.html
@@ -1801,23 +1801,18 @@ zero.
<dd><em>H5T_str_t </em><code>H5Tget_strpad</code>(<em>hid_t </em><code>type_id</code>
)
<dt><strong>Purpose:</strong>
- <dd>Retrieves the string padding method for a string datatype.
+ <dd>Retrieves the storage mechanism for a string datatype.
<dt><strong>Description:</strong>
- <dd><code>H5Tget_strpad</code> retrieves the string padding method
- for a string datatype. Valid string padding types are:
- <ul> <dl>
- <dt>H5T_STR_NULL (<code>0</code>)
- <dd>Pad with zeros (as C does)
- <dt>H5T_STR_SPACE (<code>1</code>)
- <dd>Pad with spaces (as FORTRAN does)
- </dl> </ul>
+ <dd><code>H5Tget_strpad</code> retrieves the storage mechanism
+ for a string datatype, as defined in
+ <a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>type_id</code>
<dd>Identifier of datatype to query.
</dl>
<dt><strong>Returns:</strong>
- <dd>Returns a valid string padding type if successful;
+ <dd>Returns a valid string storage mechanism if successful;
otherwise <code>H5T_STR_ERROR</code> (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5t_FORTRAN.html#h5tget_strpad_f"