mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-18 15:15:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r2427] RM_H5T.html

Browse Source 
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.
This commit is contained in:
Frank Baker 2000-07-06 11:31:40 -05:00
parent 031768b5e2
commit 56289a2c10
2 changed files with 29 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/html/RM_H5F.html
View File

@ -557,22 +557,32 @@ facilitate moving easily between them.</i>
<dl> <dl>
<dt><strong>Name:</strong> <a name="File-Reopen">H5Freopen</a> <dt><strong>Name:</strong> <a name="File-Reopen">H5Freopen</a>
<dt><strong>Signature:</strong> <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> <dt><strong>Purpose:</strong>
<dd>Reopens an HDF5 file. <dd>Returns a new identifier for a previously-opened HDF5 file.
<dt><strong>Description:</strong> <dt><strong>Description:</strong>
<dd><code>H5Freopen</code> reopens an HDF5 file. The new <dd><code>H5Freopen</code> returns a new file identifier for an
file identifier which is returned points to the same file already-open HDF5 file, as specified by <code>file_id</code>.
as the specified file idetifier, <code>file_id</code>.
Both identifiers share caches and other information. Both identifiers share caches and other information.
The only difference between the identifiers is that the The only difference between the identifiers is that the
new identifier is not mounted anywhere and no files are new identifier is not mounted anywhere and no files are
mounted on it. 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&nbsp;(file_id) </code> then use
<code> H5Freopen&nbsp;(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> <dt><strong>Parameters:</strong>
<dl> <dl>
<dt><em>hid_t</em> <code>file_id</code> <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> </dl>
<dt><strong>Returns:</strong> <dt><strong>Returns:</strong>
<dd>Returns a new file identifier if successful; <dd>Returns a new file identifier if successful;

22
doc/html/RM_H5T.html
View File

@ -684,6 +684,9 @@ H5Tget_overflow ()
<dt><em>hid_t</em> <code>base_type_id</code> <dt><em>hid_t</em> <code>base_type_id</code>
<dd>Base type of datatype to create. <dd>Base type of datatype to create.
</dl> </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> <dt><strong>Returns:</strong>
<dd>Returns datatype identifier if successful; <dd>Returns datatype identifier if successful;
otherwise returns a negative value. otherwise returns a negative value.
@ -873,15 +876,16 @@ H5Tget_overflow ()
<dd><code>H5Tget_class</code> returns the datatype class identifier. <dd><code>H5Tget_class</code> returns the datatype class identifier.
<p> <p>
Valid class identifiers, as defined in <code>H5Tpublic.h</code>, are: Valid class identifiers, as defined in <code>H5Tpublic.h</code>, are:
<ul><li><code>H5T_INTEGER</code> (<code>0</code>) <ul><li><code>H5T_INTEGER</code>
<li><code>H5T_FLOAT</code> (<code>1</code>) <li><code>H5T_FLOAT</code>
<li><code>H5T_TIME</code> (<code>2</code>) <li><code>H5T_TIME</code>
<li><code>H5T_STRING</code> (<code>3</code>) <li><code>H5T_STRING</code>
<li><code>H5T_BITFIELD</code> (<code>4</code>) <li><code>H5T_BITFIELD</code>
<li><code>H5T_OPAQUE</code> (<code>5</code>) <li><code>H5T_OPAQUE</code>
<li><code>H5T_COMPOUND</code> (<code>6</code>) <li><code>H5T_COMPOUND</code>
<li><code>H5T_REFERENCE</code> (<code>7</code>) <li><code>H5T_REFERENCE</code>
<li><code>H5T_ENUM</code> (<code>8</code>) <li><code>H5T_ENUM</code>
<li><code>H5T_VLEN</code>
</ul> </ul>
<dt><strong>Parameters:</strong> <dt><strong>Parameters:</strong>
<dl> <dl>