diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 1998-12-21 22:52:56 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 1998-12-21 22:52:56 (GMT) |
| commit | 82fb21b613326522eb0a51f507fd836fb5879c9a (patch) | |
| tree | 7a115f14a272d6264b2fb6caafcb97bd13f8de08 /doc/html/RM_H5F.html | |
| parent | 4952ed4a3691e8e873fc13dd52a38feb0e0935c0 (diff) | |
| download | hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.zip hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.tar.gz hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.tar.bz2 | |
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet
been checked into "HDF5 Development" branch.
General
=======
Various "copy edit" types of repairs.
Revisions to document cross-linking.
Added structural links tying all docs together (banners
at top and bottom of documents, similar to Reference Manual
banners of the Beta release).
Set background color to white in all documents.
NCSAfooterlogo.gif
hdf2.jpg
New image files to make the documents more self-contained
(i.e., to prevent loading images from NCSA and HDF home servers).
index.html
Redesigned to isolate links external to the installation
in a single location.
Intro to HDF5
=============
H5.intro.html
Fixed banner linking Intro to other docs.
Set all URLs to be relative within the distribution; nothing
points back to the HDF server.
Updates to "Limits of the Current Release" and "Changes in
the Current Release."
HDF5 User's Guide
=================
Changed several User Guide section titles such that all
sections that are primarily about a particular interface
are now titled in the format "The xxxxx Interface (H5x)".
H5.user.html
Commented out links to developer docs since they are marked
in MANIFEST as not being for distribution in the release.
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
Datatypes.html
Removed the sentence "I'm deferring definition until later
since they're probably not as important as the other data
types." from Section 3.3, "Properties of Date and Time
Atomic Types."
Added info regarding 'char' versus 'string' datatypes. Added
as Section 3.7, "Character and String Datatype Issues."
References.html
Commented out substantial material (at end of document) from
References planning document that is not appropriate for
the User Guide but that is worth keeping around.
Groups.html
Final edits from elimination of "current working group."
HDF5 Reference Manual
=====================
Removed "Draft" from the <title>__</title> lines.
RM_H5Front.html
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
RM_H5F.html
RM_H5P.html
Add file mounting information.
Diffstat (limited to 'doc/html/RM_H5F.html')
| -rw-r--r-- | doc/html/RM_H5F.html | 123 |
1 files changed, 112 insertions, 11 deletions
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 220a307..4325dd0 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5F Draft API Specification +HDF5/H5F API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5F Draft API Specification H5F <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5F <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5F: File Interface</h1> </center> @@ -49,6 +63,8 @@ documented below. <ul> <li><a href="#File-Flush">H5Fflush</a> <li><a href="#File-Close">H5Fclose</a> + <li><a href="#File-Mount">H5Fmount</a> + <li><a href="#File-Unmount">H5Funmount</a> <li><a href="#File-Reopen">H5Freopen</a> </ul> </td><td> </td><td valign=top> @@ -326,6 +342,78 @@ documented below. <hr> <dl> +<dt><strong>Name:</strong> <a name="File-Mount">H5Fmount</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Fmount</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>hid_t</em> <code>child_id</code>, + <em>hid_t</em> <code>plist_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Mounts a file. +<dt><strong>Description:</strong> + <dd><code>H5Fmount</code> mounts the file specified by + <code>child_id</code> onto the group specified by + <code>loc_id</code> and <code>name</code> using + the mount properties <code>plist_id</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>The identifier for the group onto which the + file specified by <code>child_id</code> + is to be mounted. + <dt><em>const char *</em><code>name</code> + <dd>The name of the group onto which the + file specified by <code>child_id</code> + is to be mounted. + <dt><em>hid_t</em> <code>child_id</code> + <dd>The identifier of the file to be mounted. + <dt><em>hid_t</em> <code>plist_id</code> + <dd>The identifier of the property list to be used. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="File-Unmount">H5Funmount</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Funmount</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code> + ) +<dt><strong>Purpose:</strong> + <dd>Unmounts a file. +<dt><strong>Description:</strong> + <dd>Given a mount point, <code>H5Funmount</code> + dissassociates the mount point's file + from the file mounted there. This function + does not close either file. + <p> + The mount point can either be the group in the + parent or the root group of the mounted file + (both groups have the same name). If the mount + point was opened before the mount then it is the + group in the parent; if it was opened after the + mount then it is the root group of the child. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>The identifier for the location at which + the specified file is to be unmounted. + <dt><em>const char *</em><code>name</code> + <dd>The name of the file to be unmounted. + </dl> +<dt><strong>Returns:</strong> + <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> @@ -353,7 +441,19 @@ documented below. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -361,6 +461,7 @@ documented below. H5F <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -368,17 +469,17 @@ H5F <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> |