diff options
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> |