[svn-r830] ======
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
This commit is contained in:
Frank Baker
@@ -14,7 +14,10 @@ HDF5/H5F Draft API Specification
|
||||
<a href="RM_H5E.html">H5E</a>
|
||||
H5F
|
||||
<a href="RM_H5G.html">H5G</a>
|
||||
<a href="RM_H5I.html">H5I</a>
|
||||
<a href="RM_H5P.html">H5P</a>
|
||||
<a href="RM_H5R.html">H5R</a>
|
||||
<a href="RM_H5RA.html">H5RA</a>
|
||||
<a href="RM_H5S.html">H5S</a>
|
||||
<a href="RM_H5T.html">H5T</a>
|
||||
<a href="RM_H5Z.html">H5Z</a>
|
||||
@@ -46,6 +49,7 @@ documented below.
|
||||
<ul>
|
||||
<li><a href="#File-Flush">H5Fflush</a>
|
||||
<li><a href="#File-Close">H5Fclose</a>
|
||||
<li><a href="#File-Reopen">H5Freopen</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
<ul>
|
||||
@@ -102,7 +106,7 @@ documented below.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a file identifier if successful;
|
||||
otherwise FAIL (-1).
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -166,7 +170,7 @@ documented below.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a file identifier if successful;
|
||||
otherwise FAIL (-1).
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -174,7 +178,8 @@ documented below.
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t </em><code>H5Fflush</code>(<em>hid_t </em><code>object_id</code>
|
||||
<dd><em>herr_t </em><code>H5Fflush</code>(<em>hid_t </em><code>object_id</code>,
|
||||
<em>H5F_scope_t</em> <code>scope</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Flushes all buffers associated with a file to disk.
|
||||
@@ -186,14 +191,29 @@ documented below.
|
||||
<code>object_id</code> can be any object associated with the file,
|
||||
including the file itself, a dataset, a group, an attribute, or
|
||||
a named data type.
|
||||
<p>
|
||||
<code>scope</code> specifies whether the scope of the flushing
|
||||
action is global or local. Valid values are
|
||||
<center>
|
||||
<table border=0>
|
||||
<tr><td align=left valign=bottom><code>H5F_SCOPE_GLOBAL</code></td>
|
||||
<td> </td>
|
||||
<td align=left valign=bottom>Flushes the entire virtual file.</td></tr>
|
||||
<tr><td align=left valign=bottom><code>H5F_SCOPE_LOCAL</code></td>
|
||||
<td></td>
|
||||
<td align=left valign=bottom>Flushes only the specified file.</td></tr>
|
||||
</table>
|
||||
</center>
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>const char *</em><code>object_id</code>
|
||||
<dd>Identifier of object used to identify the file.
|
||||
<dt><em>H5F_scope_t</em> <code>scope</code>
|
||||
<dd>Specifies the scope of the flushing action.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns SUCCEED (0) if successful;
|
||||
otherwise returns FAIL (-1).
|
||||
<dd>Returns a non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -215,7 +235,7 @@ documented below.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful.
|
||||
Otherwise returns FAIL (-1).
|
||||
Otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -247,7 +267,7 @@ documented below.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a file creation property list identifier if successful;
|
||||
otherwise FAIL (-1).
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -276,7 +296,7 @@ documented below.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a file access property list identifier if successful;
|
||||
otherwise FAIL (-1).
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -299,8 +319,35 @@ documented below.
|
||||
<dd>Identifier of a file to terminate access to.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns SUCCEED (0) if successful;
|
||||
otherwise FAIL (-1).
|
||||
<dd>Returns a non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<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>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Reopens an 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>.
|
||||
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.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>file_id</code>
|
||||
<dd>Identifier of a file to terminate access to.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a new file identifier if successful;
|
||||
otherwise returns a negative value.
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -313,7 +360,10 @@ documented below.
|
||||
<a href="RM_H5E.html">H5E</a>
|
||||
H5F
|
||||
<a href="RM_H5G.html">H5G</a>
|
||||
<a href="RM_H5I.html">H5I</a>
|
||||
<a href="RM_H5P.html">H5P</a>
|
||||
<a href="RM_H5R.html">H5R</a>
|
||||
<a href="RM_H5RA.html">H5RA</a>
|
||||
<a href="RM_H5S.html">H5S</a>
|
||||
<a href="RM_H5T.html">H5T</a>
|
||||
<a href="RM_H5Z.html">H5Z</a>
|
||||
@@ -328,7 +378,7 @@ H5F
|
||||
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
||||
|
||||
<br>
|
||||
Last modified: 14 August 1998
|
||||
Last modified: 27 October 1998
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user