diff options
Diffstat (limited to 'doc/html/RM_H5F.html')
| -rw-r--r-- | doc/html/RM_H5F.html | 46 |
1 files changed, 40 insertions, 6 deletions
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index cbb0a48..5ecc148 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -18,7 +18,10 @@ H5F <a href="RM_H5S.html">H5S</a> <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> +--> </center> <hr> @@ -37,10 +40,11 @@ documented below. <ul> <li><a href="#File-Open">H5Fopen</a> <li><a href="#File-Create">H5Fcreate</a> + <li><a href="#File-IsHDF5">H5Fis_hdf5</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#File-IsHDF5">H5Fis_hdf5</a> + <li><a href="#File-Flush">H5Fflush</a> <li><a href="#File-Close">H5Fclose</a> </ul> </td><td> </td><td valign=top> @@ -126,8 +130,8 @@ documented below. The more complex behaviors of file creation and access are controlled through the file-creation and file-access property lists. The value of <code>H5P_DEFAULT</code> for - a property list value indicates that the library should use - the default values for the appropriate property list. Also see + a property list value indicates that the library should use + the default values for the appropriate property list. Also see <code>H5Fpublic.h</code> for the list of supported flags. <dt><strong>Parameters:</strong> <dl> @@ -151,13 +155,13 @@ documented below. <dd>Apply default file access and creation properties. </dl></ul> <dt><em>hid_t</em> <code>create_id</code> - <dd>File creation property list identifier, used when modifying + <dd>File creation property list identifier, used when modifying default file meta-data. <dt><em>hid_t</em> <code>access_id</code> <dd>File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the - <code>access_id</code>. + <code>access_id</code>. Use <code>0</code> for default access properties. </dl> <dt><strong>Returns:</strong> @@ -168,6 +172,33 @@ documented below. <hr> <dl> +<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Fis_hdf5</code>(<em>hid_t </em><code>object_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Flushes all buffers associated with a file to disk. +<dt><strong>Description:</strong> + <dd><code>H5Fflush</code> causes all buffers associated with a + file to be immediately flushed to disk without removing the + data from the cache. + <p> + <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. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>const char *</em><code>object_id</code> + <dd>Identifier of object used to identify the file. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a> <dt><strong>Signature:</strong> <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code> @@ -286,7 +317,10 @@ H5F <a href="RM_H5S.html">H5S</a> <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> +--> </center> <hr> @@ -294,7 +328,7 @@ H5F <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 14 August 1998 </body> </html> |