diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2000-07-06 16:31:40 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2000-07-06 16:31:40 (GMT) |
commit | 56289a2c103733ea0a8264aaa4db8956f52bfc66 (patch) | |
tree | 24507505ef69d7a3b2e587ff174103aa2e15ea58 | |
parent | 031768b5e286493204fb2c52e1a6188277fe6379 (diff) | |
download | hdf5-56289a2c103733ea0a8264aaa4db8956f52bfc66.zip hdf5-56289a2c103733ea0a8264aaa4db8956f52bfc66.tar.gz hdf5-56289a2c103733ea0a8264aaa4db8956f52bfc66.tar.bz2 |
[svn-r2427] RM_H5T.html
H5Tvlen_create: Added cross-reference to H5Dget_vlen_buf_size
and H5Dvlen_reclaim.
H5Tget_class: Removed numbers from class identifiers list.
Added H5T_VLEN to class identifiers list.
RM_H5F.html
H5Freopen: Corrected description of file_id parameter.
Added comment about eventually closing returned identifier.
Added clarification that function cannot open closed files.
-rw-r--r-- | doc/html/RM_H5F.html | 22 | ||||
-rw-r--r-- | doc/html/RM_H5T.html | 22 |
2 files changed, 29 insertions, 15 deletions
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index be8107c..a794332 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -557,22 +557,32 @@ facilitate moving easily between them.</i> <dl> <dt><strong>Name:</strong> <a name="File-Reopen">H5Freopen</a> <dt><strong>Signature:</strong> - <dd><em>hid__t </em><code>H5Freopen</code>(<em>hid_t</em> <code>file_id</code> + <dd><em>hid_t </em><code>H5Freopen</code>(<em>hid_t</em> <code>file_id</code> ) <dt><strong>Purpose:</strong> - <dd>Reopens an HDF5 file. + <dd>Returns a new identifier for a previously-opened HDF5 file. <dt><strong>Description:</strong> - <dd><code>H5Freopen</code> reopens an HDF5 file. The new - file identifier which is returned points to the same file - as the specified file idetifier, <code>file_id</code>. + <dd><code>H5Freopen</code> returns a new file identifier for an + already-open HDF5 file, as specified by <code>file_id</code>. Both identifiers share caches and other information. The only difference between the identifiers is that the new identifier is not mounted anywhere and no files are mounted on it. + <p> + Note that there is no circumstance under which + <code>H5Freopen</code> can actually open a closed file; + the file must already be open and have an active + <code>file_id</code>. E.g., one cannot close a file with + <code> H5Fclose (file_id) </code> then use + <code> H5Freopen (file_id) </code> to reopen it. + <p> + The new file identifier should be closed by calling + <code>H5Fclose()</code> when it is no longer needed. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>file_id</code> - <dd>Identifier of a file to terminate access to. + <dd>Identifier of a file for which an additional identifier + is required. </dl> <dt><strong>Returns:</strong> <dd>Returns a new file identifier if successful; diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 8d42d14..f0a14a4 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -684,6 +684,9 @@ H5Tget_overflow () <dt><em>hid_t</em> <code>base_type_id</code> <dd>Base type of datatype to create. </dl> +<dt><strong>See Also:</strong> + <dd><a href="RM_H5D.html#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a> + <dd><a href="RM_H5D.html#Dataset-VLReclaim">H5Dvlen_reclaim</a> <dt><strong>Returns:</strong> <dd>Returns datatype identifier if successful; otherwise returns a negative value. @@ -873,15 +876,16 @@ H5Tget_overflow () <dd><code>H5Tget_class</code> returns the datatype class identifier. <p> Valid class identifiers, as defined in <code>H5Tpublic.h</code>, are: - <ul><li><code>H5T_INTEGER</code> (<code>0</code>) - <li><code>H5T_FLOAT</code> (<code>1</code>) - <li><code>H5T_TIME</code> (<code>2</code>) - <li><code>H5T_STRING</code> (<code>3</code>) - <li><code>H5T_BITFIELD</code> (<code>4</code>) - <li><code>H5T_OPAQUE</code> (<code>5</code>) - <li><code>H5T_COMPOUND</code> (<code>6</code>) - <li><code>H5T_REFERENCE</code> (<code>7</code>) - <li><code>H5T_ENUM</code> (<code>8</code>) + <ul><li><code>H5T_INTEGER</code> + <li><code>H5T_FLOAT</code> + <li><code>H5T_TIME</code> + <li><code>H5T_STRING</code> + <li><code>H5T_BITFIELD</code> + <li><code>H5T_OPAQUE</code> + <li><code>H5T_COMPOUND</code> + <li><code>H5T_REFERENCE</code> + <li><code>H5T_ENUM</code> + <li><code>H5T_VLEN</code> </ul> <dt><strong>Parameters:</strong> <dl> |