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

[svn-r2330] RM_H5Front.html -- Minor reformatting.

Browse Source 
RM_H5A.html -- H5Aiterate: Changed function type to herr_t.
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.
RM_H5T.html -- H5Tget_class:  Removed numbers from class identifiers list.
	    Added H5T_VLEN to class identifiers list.
This commit is contained in:
Frank Baker
2000-06-02 17:02:04 -05:00
parent a8bc29e611
commit 6ff669ade2
4 changed files with 52 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/html/RM_H5F.html
View File

@@ -10,9 +10,9 @@ HDF5/H5F API Specification
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User's Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
@@ -445,22 +445,32 @@ documented below.
<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&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>
<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;
@@ -472,9 +482,9 @@ documented below.
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User's Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->