summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2003-10-09 19:20:47 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2003-10-09 19:20:47 (GMT)
commit9ef846aef1ac23f6979a076d61f6ba7dda31ec42 (patch)
treea9edab33898b9337f14ed31206ab4c9391c02d23 /doc
parent62311b71ee775fa2c3b29bc585d1cd03f4c7d021 (diff)
downloadhdf5-9ef846aef1ac23f6979a076d61f6ba7dda31ec42.zip
hdf5-9ef846aef1ac23f6979a076d61f6ba7dda31ec42.tar.gz
hdf5-9ef846aef1ac23f6979a076d61f6ba7dda31ec42.tar.bz2
[svn-r7589]
Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5A.html218
1 files changed, 174 insertions, 44 deletions
diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html
index 11b8cc6..a14f58e 100644
--- a/doc/html/RM_H5A.html
+++ b/doc/html/RM_H5A.html
@@ -229,8 +229,7 @@ SUBROUTINE h5aclose_f(attr_id, hdferr)
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5aclose_f
- </pre>
-
+ </pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
@@ -351,10 +350,21 @@ END SUBROUTINE h5acreate_f
<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/h5a_FORTRAN.html#h5adelete_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5adelete_f
+ <dd>
+ <pre>
+SUBROUTINE h5adelete_f(obj_id, name, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
+ CHARACTER(LEN=*), INTENT(IN) :: name ! Attribute name
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5adelete_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -393,10 +403,22 @@ END SUBROUTINE h5acreate_f
<dd>Returns the length of the attribute's name, which may be
longer than <code>buf_size</code>, if successful.
Otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aget_name_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aget_name_f
+ <dd>
+ <pre>
+SUBROUTINE h5aget_name_f(attr_id, size, buf, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
+ INTEGER, INTENT(IN) :: size ! Buffer size
+ CHARACTER(LEN=*), INTENT(OUT) :: buf ! Buffer to hold attribute name
+ INTEGER, INTENT(OUT) :: hdferr ! Error code : name length
+ ! on success and -1 on failure
+END SUBROUTINE h5aget_name_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -424,10 +446,22 @@ END SUBROUTINE h5acreate_f
<dt><strong>Returns:</strong>
<dd>Returns the number of attributes if successful;
otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aget_num_attrs_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aget_num_attrs_f
+ <dd>
+ <pre>
+SUBROUTINE h5aget_num_attrs_f(obj_id, attr_num, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
+ INTEGER, INTENT(OUT) :: attr_num ! Number of attributes of the
+ ! object
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aget_num_attrs_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -455,10 +489,21 @@ END SUBROUTINE h5acreate_f
<dt><strong>Returns:</strong>
<dd>Returns attribute dataspace identifier if successful;
otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aget_space_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aget_space_f
+ <dd>
+ <pre>
+SUBROUTINE h5aget_space_f(attr_id, space_id, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
+ INTEGER(HID_T), INTENT(OUT) :: space_id ! Attribute dataspace identifier
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aget_space_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -492,10 +537,21 @@ END SUBROUTINE h5acreate_f
<dt><strong>Returns:</strong>
<dd>Returns a datatype identifier if successful;
otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aget_type_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aget_type_f
+ <dd>
+ <pre>
+SUBROUTINE h5aget_type_f(attr_id, type_id, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
+ INTEGER(HID_T), INTENT(OUT) :: type_id ! Attribute datatype identifier
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aget_type_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -564,11 +620,17 @@ END SUBROUTINE h5acreate_f
<dd>If successful, returns the return value of the last operator
if it was non-zero, or zero if all attributes were processed.
Otherwise returns a negative value.
-<!--
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aiterate_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
---> <!--
+<dt><strong>Fortran90 Interface:</strong>
+ <dd>None.
+<!--
+ <pre>
+SUBROUTINE
+ </pre>
+-->
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -606,10 +668,22 @@ END SUBROUTINE h5acreate_f
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_idx_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aopen_idx_f
+ <dd>
+ <pre>
+SUBROUTINE h5aopen_idx_f(obj_id, index, attr_id, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
+ INTEGER, INTENT(IN) :: index ! Attribute index
+ INTEGER(HID_T), INTENT(OUT) :: attr_id ! Attribute identifier
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aopen_idx_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -646,10 +720,22 @@ END SUBROUTINE h5acreate_f
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_name_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aopen_name_f
+ <dd>
+ <pre>
+SUBROUTINE h5aopen_name_f(obj_id, name, attr_id, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
+ CHARACTER(LEN=*), INTENT(IN) :: name ! Attribute name
+ INTEGER(HID_T), INTENT(OUT) :: attr_id ! Attribute identifier
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aopen_name_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -692,10 +778,32 @@ END SUBROUTINE h5acreate_f
<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/h5a_FORTRAN.html#h5aread_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5aread_f
+ <dd>
+ <pre>
+SUBROUTINE h5aread_f(attr_id, memtype_id, buf, dims, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
+ INTEGER(HID_T), INTENT(IN) :: memtype_id ! Attribute datatype
+ ! identifier (in memory)
+ TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar or an array
+ DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
+ ! Array to hold corresponding dimension
+ ! sizes of data buffer buf; dim(k) has
+ ! value of the k-th dimension of buffer buf;
+ ! values are ignored if buf is a scalar
+ !
+ ! Deprecated type, will be removed in
+ ! Release 1.6:
+ ! INTEGER, INTENT(IN) :: dims(7)
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5aread_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -738,10 +846,32 @@ END SUBROUTINE h5acreate_f
<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/h5a_FORTRAN.html#h5awrite_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
+<dt><strong>Fortran90 Interface:</strong> h5awrite_f
+ <dd>
+ <pre>
+SUBROUTINE h5awrite_f(attr_id, memtype_id, buf, dims, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier
+ INTEGER(HID_T), INTENT(IN) :: memtype_id ! Attribute datatype
+ ! identifier (in memory)
+ TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar or an array
+ DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
+ ! Array to hold corresponding dimension
+ ! sizes of data buffer buf; dim(k) has
+ ! value of the k-th dimension of buffer buf;
+ ! values are ignored if buf is a scalar
+ !
+ ! Deprecated type, will be removed in
+ ! Release 1.6:
+ ! INTEGER, INTENT(IN) :: dims(7)
+ INTEGER, INTENT(OUT) :: hdferr ! Error code
+ ! 0 on success and -1 on failure
+END SUBROUTINE h5awrite_f
+ </pre>
+
+ <!--<dt><strong>Non-C API(s):</strong>
+ <dd>
+
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
@@ -786,7 +916,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: 9 October 2003");
-->
</SCRIPT>