diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/RM_H5E.html | 171 | ||||
| -rw-r--r-- | doc/html/RM_H5I.html | 66 | ||||
| -rw-r--r-- | doc/html/RM_H5R.html | 135 |
3 files changed, 271 insertions, 101 deletions
diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index e5fa126..ff5a2d8 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -131,18 +131,10 @@ These functions provide error handling capabilities in the HDF5 environment. <br> <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 (electronic versions only) 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><br> +In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. +<br> <table border=0> <tr><td valign=top> @@ -216,10 +208,19 @@ errors within the H5E package. <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/h5e_FORTRAN.html#h5eclear_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5eclear_f + <dd> + <pre> +SUBROUTINE h5eclear_f(hdferr) + IMPLICIT NONE + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5eclear_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -253,12 +254,18 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Fortran90 Interface:</strong> + <dd>None. + <!-- -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5eget_auto_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> ---> - <!-- + <pre> +SUBROUTINE + </pre> +--> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -285,10 +292,20 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5eget_major_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5eget_major_f + <dd> + <pre> +SUBROUTINE h5eget_major_f(error_no, name, hdferr) + INTEGER, INTENT(IN) :: error_no !Major error number + CHARACTER(LEN=*), INTENT(OUT) :: name ! File name + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5eget_major_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -315,10 +332,20 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5eget_minor_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5eget_minor_f + <dd> + <pre> +SUBROUTINE h5eget_minor_f(error_no, name, hdferr) + INTEGER, INTENT(IN) :: error_no !Major error number + CHARACTER(LEN=*), INTENT(OUT) :: name ! File name + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5eget_minor_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -351,10 +378,19 @@ errors within the H5E package. <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/h5e_FORTRAN.html#h5eprint_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5eprint_f + <dd> + <pre> +SUBROUTINE h5eprint_f(hdferr, name) + CHARACTER(LEN=*), OPTIONAL, INTENT(IN) :: name ! File name + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5eprint_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -407,12 +443,18 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Fortran90 Interface:</strong> + <dd>None. + <!-- -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5epush_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> ---> - <!-- + <pre> +SUBROUTINE + </pre> +--> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -453,10 +495,23 @@ errors within the H5E package. <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/h5e_FORTRAN.html#h5eset_auto_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5eset_auto_f + <dd> + <pre> +SUBROUTINE h5eset_auto_f(printflag, hdferr) + INTEGER, INTENT(IN) :: printflag !flag to turn automatic error + !printing on or off + !possible values are: + !printon (1) + !printoff(0) + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5eset_auto_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -531,12 +586,18 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Fortran90 Interface:</strong> + <dd>None. + <!-- -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5ewalk_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> ---> - <!-- + <pre> +SUBROUTINE + </pre> +--> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -589,12 +650,18 @@ errors within the H5E package. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Fortran90 Interface:</strong> + <dd>None. + <!-- -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5e_FORTRAN.html#h5ewalk_cb_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> ---> - <!-- + <pre> +SUBROUTINE + </pre> +--> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -639,7 +706,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 3 October 2003"); +document.writeln("Last modified: 21 October 2003"); --> </SCRIPT> diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 409de63..9106582 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -92,19 +92,11 @@ object names. <br> -<strong>The FORTRAN90 Interface:</strong> - +<strong>The FORTRAN90 Interfaces:</strong> +<br> +In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. <br> -<font size=-1> -<i>In general, each FORTRAN90 subroutine performs exactly the same task -as the corresponding C function. The links below (electronic versions only) 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><br> <table border=0> <tr><td valign=top> @@ -174,10 +166,23 @@ facilitate moving easily between them.</i> <dd>Returns the length of the name if successful, returning <code>0</code> (zero) if no name is associated with the identifier. Otherwise returns a negative value. -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5i_FORTRAN.html#h5iget_name_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5iget_name_f + <dd> + <pre> +SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier + CHARACTER(LEN=*), INTENT(OUT) :: buf ! Buffer to hold object name + INTEGER(SIZE_T), INTENT(IN) :: buf_size ! Buffer size + INTEGER(SIZE_T), INTENT(OUT) :: name_size ! Name size + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success, and -1 on failure +END SUBROUTINE h5iget_name_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -230,10 +235,29 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns the object type if successful; otherwise <code>H5I_BADID</code>. -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5i_FORTRAN.html#h5iget_type_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5iget_type_f + <dd> + <pre> +SUBROUTINE h5iget_type_f(obj_id, type, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: obj_id !Object identifier + INTEGER, INTENT(OUT) :: type !type of an object. + !possible values are: + !H5I_FILE_F(1) + !H5I_GROUP_F(2) + !H5I_DATATYPE_F(3) + !H5I_DATASPACE_F(4) + !H5I_DATASET_F(5) + !H5I_ATTR_F(6) + !H5I_BADID_F(-1) + INTEGER, INTENT(OUT) :: hdferr ! E rror code + ! 0 on success, and -1 on failure +END SUBROUTINE h5iget_type_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -278,7 +302,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 3 October 2003"); +document.writeln("Last modified: 21 October 2003"); --> </SCRIPT> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index f838e75..cc08529 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -124,18 +124,10 @@ to specific objects and data regions in an HDF5 file. <br> <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 (electronic versions only) 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><br> +In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. +<br> <table border=0 width=80%> <tr><td valign=top width=40%> @@ -219,10 +211,40 @@ 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/h5r_FORTRAN.html#h5rcreate_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5rcreate_f + + <p><strong>To create an object reference</strong> + <dd> + <pre> +SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object at location + ! specified by loc_id identifier + TYPE(hobj_ref_t_f), INTENT(OUT) :: ref ! Object reference + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rcreate_f + </pre></dt> + +<dt><strong>To create a region reference</strong> + <dd> + <pre> +SUBROUTINE h5rcreate_f(loc_id, name, space_id, ref, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset at location + ! specified by loc_id identifier + INTEGER(HID_T), INTENT(IN) :: space_id ! Dataset's dataspace identifier + TYPE(hdset_reg_ref_t_f), INTENT(OUT) :: ref ! Dataset region reference + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rcreate_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -263,10 +285,38 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns valid identifier if successful; otherwise returns a negative value. -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5r_FORTRAN.html#h5rdereference_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5rdereference_f + + <p><strong>To dereference an object</strong> + <dd> + <pre> +SUBROUTINE h5rdereference_f(dset_id, ref, obj_id, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier + TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference + INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rdereference_f + </pre> +</dt> + +<dt><strong>To dereference a region</strong> + <dd> + <pre> +SUBROUTINE h5rdereference_f(dset_id, ref, obj_id, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier + TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Object reference + INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rdereference_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -336,10 +386,27 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <dd>Returns an object type as defined in <code>H5Gpublic.h</code> if successful; otherwise returns <code>H5G_UNKNOWN</code>. -<dt><strong>Non-C API(s):</strong> - <dd><a href="fortran/h5r_FORTRAN.html#h5rget_object_type_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5rget_object_type_f + <dd> + <pre> +SUBROUTINE h5rget_object_type_f(dset_id, ref, obj_type, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier + TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference + INTEGER, INTENT(OUT) :: obj_type ! Object type + ! H5G_UNKNOWN_F (-1) + ! H5G_LINK_F 0 + ! H5G_GROUP_F 1 + ! H5G_DATASET_F 2 + ! H5G_TYPE_F 3 + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rget_object_type_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -382,10 +449,22 @@ facilitate moving easily between them.</i> <dt><strong>Returns:</strong> <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_f" - target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> - <!-- +<dt><strong>Fortran90 Interface:</strong> h5rget_region_f + <dd> + <pre> +SUBROUTINE h5rget_region_f(dset_id, ref, space_id, hdferr) + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier + TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Dataset region reference + INTEGER(HID_T), INTENT(OUT) :: space_id ! Space identifier + INTEGER, INTENT(OUT) :: hdferr ! Error code + +END SUBROUTINE h5rget_region_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> @@ -430,7 +509,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 8 October 2003"); +document.writeln("Last modified: 21 October 2003"); --> </SCRIPT> |