philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r7691]

Browse Source 
Description:
    Integrate Fortran90 function descriptions
        Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
        Remove note that Fortran APIs are described in a separate window

Platforms tested:
    Safari
This commit is contained in:
Frank Baker
2003-10-21 17:18:46 -05:00
parent bc020e6b70
commit bcce957f4b
3 changed files with 271 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
doc/html/RM_H5R.html
View File

@@ -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>