diff options
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/PredefDTypes.html | 4 | ||||
| -rw-r--r-- | doc/html/RM_H5.html | 90 | ||||
| -rw-r--r-- | doc/html/RM_H5F.html | 14 | ||||
| -rw-r--r-- | doc/html/RM_H5Front.html | 12 | ||||
| -rw-r--r-- | doc/html/RM_H5P.html | 107 | ||||
| -rw-r--r-- | doc/html/RM_H5R.html | 10 | ||||
| -rw-r--r-- | doc/html/RM_H5S.html | 5 | ||||
| -rw-r--r-- | doc/html/RM_H5T.html | 27 |
8 files changed, 183 insertions, 86 deletions
diff --git a/doc/html/PredefDTypes.html b/doc/html/PredefDTypes.html index b137d04..86fb9ca 100644 --- a/doc/html/PredefDTypes.html +++ b/doc/html/PredefDTypes.html @@ -370,7 +370,9 @@ The following datatypes are predefined in HDF5. </table> +<a name="F90"> <h4>FORTRAN90 API datatypes</h4> +</a> <ul> <li>Datatypes defined for the FORTRAN90 APIs <br> @@ -485,7 +487,7 @@ And in this document, the <br> Last modified: 12 December 2000 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 7625f4a..b19b30c 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -49,6 +49,9 @@ H5 These functions serve general-purpose needs of the HDF5 library and it users. +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <ul> @@ -68,6 +71,37 @@ and it users. </td></tr> </table> +<p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Library-Open">h5open_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Library-Close">h5close_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + +</ul> +</td></tr> +</table> + <hr> <dl> @@ -88,6 +122,13 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5open_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -101,7 +142,7 @@ and it users. <dt><strong>Description:</strong> <dd><code>H5close</code> flushes all data to disk, closes all file identifiers, and cleans up all memory used by - the library. This function is generall called when the + the library. This function is generally called when the application calls <code>exit</code>, but may be called earlier in event of an emergency shutdown or out of desire to free all resources used by the HDF5 library. @@ -112,6 +153,13 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5close_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -143,6 +191,15 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5xxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -174,6 +231,15 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5xxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -203,6 +269,15 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5xxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -242,6 +317,15 @@ and it users. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Upon failure, this function causes the application to abort. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5_FORTRAN.html#h5xxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -285,10 +369,10 @@ H5 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 17 July 2000 +Last modified: 20 March 2001 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 6cbd2a8..f09a1bb 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -444,6 +444,18 @@ facilitate moving easily between them.</i> (But the file identifier is no longer valid and cannot be used.) Once all of the remaining access identifiers are closed, the file will be fully closed and access will end. + <p> + <strong>EXCEPTION:</strong> + Note the following deviation from the above-described behavior. + If <code>H5close</code> is called for a file but one or more + objects within the file remain open, those objects will remain + accessible until they are individually closed. + Thus, if the dataset <code>data_sample</code> is open when + <code>H5close</code> is called for the file containing it, + <code>data_sample</code> will remain open and accessible + (including writable) until it is explicitely closed. + The file will be automatically closed once all objects in the + file have been closed. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>file_id</code> @@ -642,7 +654,7 @@ H5F <br> Last modified: 12 October 2000 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 97c409b..a3c94c8 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -147,6 +147,11 @@ These APIs are described in the following documents. information. You will probably want to adjust the size and location of this external window so that both browser windows are visible and to facilitate moving easily between them. + <p> + <a href="fortran/F90Flags.html" target="External"> + <cite>HDF5 Fortran90 Flags and Datatypes</cite></a> + lists the flags employed in the Fortran90 interface and + contains a pointer to the HDF5 Fortran90 datatypes. </dir> <strong>C++ API</strong> @@ -156,6 +161,9 @@ These APIs are described in the following documents. <p> <a href="cpplus/CppInterfaces.html" target="External"> <cite>HDF5 C++ Interfaces</cite></a> + <p> + (Note that the C++ APIs are not yet integrated into the + <cite>HDF5 Reference Manual</cite>.) </dir> @@ -204,9 +212,9 @@ HDF5 Reference Manual <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 19 January 2001 +Last modified: 2 April 2001 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index bd58eb8..8ef3b18 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -232,43 +232,6 @@ facilitate moving easily between them.</i> </td><td> </td><td valign=top> - <i>File Access Properties</i> - <ul> - <li><a href="#Property-GetDriver">h5pget_driver_f</a> - <li><a href="#Property-SetStdio">h5pset_stdio_f</a> - <li><a href="#Property-GetStdio">h5pget_stdio_f</a> - <li><a href="#Property-SetSec2">h5pset_sec2_f</a> - <li><a href="#Property-GetSec2">h5pget_sec2_f</a> - <li><a href="#Property-SetAlignment">h5pset_alignment_f</a> - <li><a href="#Property-GetAlignment">h5pget_alignment_f</a> - <li><a href="#Property-SetCore">h5pset_core_f</a> - <li><a href="#Property-GetCore">h5pget_core_f</a> - <li><a href="#Property-SetMPI">h5pset_mpi_f</a> || - <li><a href="#Property-GetMPI">h5pget_mpi_f</a> || -<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> --> -<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> --> - <li><a href="#Property-SetCache">h5pset_cache_f</a> - <li><a href="#Property-GetCache">h5pget_cache_f</a> - <li><a href="#Property-SetSplit">h5pset_split_f</a> - <li><a href="#Property-GetSplit">h5pget_split_f</a> - <li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a> - <li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a> - </ul> - -<!-- -<br> -<br> -<br> -<br> -<br> ---> -<br> -<br> -|| <i>Available only in the parallel HDF5 library.</i> - - -</td><td> </td><td valign=top> - <i>Dataset Creation Properties</i> <ul> <li><a href="#Property-SetLayout">h5pset_layout_f</a> @@ -289,6 +252,45 @@ facilitate moving easily between them.</i> <li><a href="#Property-GetExternal">h5pget_external_f</a> </ul> +<!-- +<br> +<br> +<br> +--> +<br> +<br> +<br> +<br> +|| <i>Available only in the parallel HDF5 library.</i> + + +</td><td> </td><td valign=top> + + + <i>File Access Properties</i> + <ul> + <li><a href="#Property-GetDriver">h5pget_driver_f</a> +<!--<li><a href="#Property-SetStdio">h5pset_stdio_f</a> --> +<!--<li><a href="#Property-GetStdio">h5pget_stdio_f</a> --> +<!--<li><a href="#Property-SetSec2">h5pset_sec2_f</a> --> +<!--<li><a href="#Property-GetSec2">h5pget_sec2_f</a> --> + <li><a href="#Property-SetAlignment">h5pset_alignment_f</a> + <li><a href="#Property-GetAlignment">h5pget_alignment_f</a> +<!--<li><a href="#Property-SetCore">h5pset_core_f</a> --> +<!--<li><a href="#Property-GetCore">h5pget_core_f</a> --> + <li><a href="#Property-SetFaplMpio">h5pset_fapl_mpi_f</a> || + <li><a href="#Property-GetFaplMpio">h5pget_fapl_mpi_f</a> || +<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> --> +<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> --> + <li><a href="#Property-SetCache">h5pset_cache_f</a> + <li><a href="#Property-GetCache">h5pget_cache_f</a> + <li><a href="#Property-SetSplit">h5pset_split_f</a> + <li><a href="#Property-GetSplit">h5pget_split_f</a> + <li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a> + <li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a> + </ul> + + <p><i>Dataset Memory and Transfer Properties</i> <ul> <!--<li><a href="#Property-SetBuffer">h5pset_buffer_f</a> --> @@ -299,8 +301,8 @@ facilitate moving easily between them.</i> <li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a> <li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a> <li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a> - <li><a href="#Property-SetXfer">h5pset_xfer_f</a> || - <li><a href="#Property-GetXfer">h5pget_xfer_f</a> || + <li><a href="#Property-SetDxplMpio">h5pset_dxpl_mpi_f</a> || + <li><a href="#Property-GetDxplMpio">h5pget_dxpl_mpi_f</a> || </ul> </td></tr> @@ -2751,11 +2753,9 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. - <!-- <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_fapl_mpi_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - --> <!-- <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> @@ -2795,11 +2795,9 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. - <!-- <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_fapl_mpi_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - --> <!-- <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> @@ -2842,11 +2840,9 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. - <!-- <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_dxpl_mpi_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - --> <!-- <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> @@ -2882,11 +2878,9 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. - <!-- <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_dxpl_mpi_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - --> <!-- <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> @@ -3185,6 +3179,9 @@ facilitate moving easily between them.</i> The split file driver stored metadata and raw data in separate files but provide no mechanism for separating types of metadata. <p> + <b><i>Caution:</i></b> This function may be changed in the next release due to a + pending extension to the function. + <p> <code>fapl_id</code> is a file access property list identifier. <p> <code>meta_ext</code> is the filename extension for the metadata file. @@ -3306,7 +3303,7 @@ facilitate moving easily between them.</i> <code>fapl_id</code> is the identifier for the file access property list currently in use. <p> - <code>fapl</code> is ... + <code>fapl</code> is the file access property list. <p> The <code>H5FD_stream_fapl_t</code> struct contains the following elements: @@ -3460,7 +3457,7 @@ facilitate moving easily between them.</i> <dl> <dt><strong>Name:</strong> <a name="Property-GetDriver">H5Pget_driver</a> <dt><strong>Signature:</strong> - <dd><em>hid_t</em> <code>H5Pget_driver</code>( + <dd><em>H5F_driver_t</em> <code>H5Pget_driver</code>( <em>hid_t</em> <code>plist_id</code> ) <dt><strong>Purpose:</strong> @@ -3992,9 +3989,9 @@ H5P <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 9 January 2001 +Last modified: 2 April 2001 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index ec8275a..efc551f 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -95,8 +95,8 @@ facilitate moving easily between them.</i> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Reference-GetRegion">h5rget_region_region_f</a> - <li><a href="#Reference-GetObjectType">h5rget_object_type_obj_f</a> + <li><a href="#Reference-GetRegion">h5rget_region_f</a> + <li><a href="#Reference-GetObjectType">h5rget_object_type_f</a> </ul> </td><td> </td><td valign=top> <ul> @@ -236,7 +236,7 @@ facilitate moving easily between them.</i> <dd>Returns a valid identifier if successful; otherwise returns a negative value. <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5r_FORTRAN.html#h5rget_region_region_f" + <dd><a href="fortran/h5r_FORTRAN.html#h5rget_region_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> <!-- <img src="Graphics/Java.gif"> @@ -271,7 +271,7 @@ facilitate moving easily between them.</i> <dd>Returns an object type as defined in <code>H5Gpublic.h</code>; otherwise returns <code>H5G_UNKNOWN</code>. <dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5r_FORTRAN.html#h5rget_object_type_obj_f" + <dd><a href="fortran/h5r_FORTRAN.html#h5rget_object_type_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> <!-- <img src="Graphics/Java.gif"> @@ -322,7 +322,7 @@ H5R <br> Last modified: 13 July 2000 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 473137b..df86fcd 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -422,8 +422,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>space_id</code> - <dd>The identifier for the dataspace in which the - selection is being reset. + <dd>The identifier for the dataspace being queried. </dl> <dt><strong>Returns:</strong> <dd>Returns a positive value, for <code>TRUE</code>, @@ -1237,7 +1236,7 @@ H5S <br> Last modified: 12 June 2000 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 71e0717..730395f 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -217,11 +217,11 @@ facilitate moving easily between them.</i> <!--<li><a href="#Datatype-GetMemberClass">H5Tget_member_class_f</a> --> <li><a href="#Datatype-GetMemberName">h5tget_member_name_f</a> <li><a href="#Datatype-GetMemberOffset">h5tget_member_offset_f</a> - <li><a href="#Datatype-GetMemberDims">h5tget_member_dims_f</a> +<!--<li><a href="#Datatype-GetMemberDims">h5tget_member_dims_f</a> --> <li><a href="#Datatype-GetMemberType">h5tget_member_type_f</a> <li><a href="#Datatype-Insert">h5tinsert_f</a> <li><a href="#Datatype-Pack">h5tpack_f</a> - <li><a href="#Datatype-InsertArray">h5tinsert_array_f</a> +<!--<li><a href="#Datatype-InsertArray">h5tinsert_array_f</a> --> <p> <i>Enumeration Datatypes</i> <li><a href="#Datatype-EnumCreate">h5tenum_create_f</a> @@ -1801,23 +1801,18 @@ zero. <dd><em>H5T_str_t </em><code>H5Tget_strpad</code>(<em>hid_t </em><code>type_id</code> ) <dt><strong>Purpose:</strong> - <dd>Retrieves the string padding method for a string datatype. + <dd>Retrieves the storage mechanism for a string datatype. <dt><strong>Description:</strong> - <dd><code>H5Tget_strpad</code> retrieves the string padding method - for a string datatype. Valid string padding types are: - <ul> <dl> - <dt>H5T_STR_NULL (<code>0</code>) - <dd>Pad with zeros (as C does) - <dt>H5T_STR_SPACE (<code>1</code>) - <dd>Pad with spaces (as FORTRAN does) - </dl> </ul> + <dd><code>H5Tget_strpad</code> retrieves the storage mechanism + for a string datatype, as defined in + <a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>type_id</code> <dd>Identifier of datatype to query. </dl> <dt><strong>Returns:</strong> - <dd>Returns a valid string padding type if successful; + <dd>Returns a valid string storage mechanism if successful; otherwise <code>H5T_STR_ERROR</code> (-1). <dt><strong>Non-C API(s):</strong> <dd><a href="fortran/h5t_FORTRAN.html#h5tget_strpad_f" @@ -2014,7 +2009,7 @@ zero. <dd>Returns the byte offset of the field if successful; otherwise returns <code>0</code> (zero). Note that zero is a valid offset and that this function - will fail only if a call to <code>H5Tget_member_dims()</code> + will fail only if a call to <code>H5Tget_member_class()</code> fails with the same arguments. <dt><strong>Non-C API(s):</strong> <dd><a href="fortran/h5t_FORTRAN.html#h5tget_member_offset_f" @@ -2608,7 +2603,7 @@ zero. <dl> <dt><strong>Name:</strong> <a name="Datatype-GetArrayDims">H5Tget_array_dims</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Tget_array_dims</code>( + <dd><em>herr_t</em> <code>H5Tget_array_dims</code>( <em>hid_t</em> <code>adtype_id</code>, <em>hsize_t *</em><code>dims[]</code>, <em>int *</em><code>perm[]</code> @@ -2716,9 +2711,9 @@ H5T <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 7 February 2001 +Last modified: 19 February 2001 <br> -Describes HDF5 Release 1.4, February 2001 +Describes HDF5 Release 1.4.1, April 2001 </body> </html> |