From bc020e6b703fa1a2624cf6a0de019a3d6de07efa Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 21 Oct 2003 16:47:24 -0500 Subject: [svn-r7690] 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 Corrected H5Gget_objname_by_idx return value description Platforms tested: Safari --- doc/html/RM_H5G.html | 403 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 309 insertions(+), 94 deletions(-) diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 416ae6e..20c6261 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -145,17 +145,10 @@ of objects in an HDF5 file.
The FORTRAN90 Interfaces: - - -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 Non-C API(s) 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. -
+
+In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. +
@@ -234,13 +227,20 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -295,13 +295,28 @@ create or access function.
Returns:
Returns a valid group identifier for the open group if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -348,10 +363,23 @@ create or access function. counting the null terminator, if successful; the value returned may be larger than bufsize. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -404,10 +432,24 @@ create or access function.
Returns a non-negative value, with the link value in value, if successful. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -438,6 +480,21 @@ create or access function.
Returns:
Returns positive value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + + @@ -528,12 +585,18 @@ create or access function.
Returns a non-negative value if successful, with the fields of statbuf (if non-null) initialized. Otherwise returns a negative value. +
Fortran90 Interface: +
None. + - + + @@ -590,8 +653,24 @@ create or access function.
IN: Name length.
Returns: -
Returns the size of the object name if successful; - otherwise returns a negative value. +
Returns the size of the object name if successful, + or 0 if no name is associated with the group identifier. + Otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + + @@ -675,6 +754,21 @@ create or access function.
Returns:
Returns the type of the object if successful. Otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + + @@ -752,16 +846,25 @@ create or access function.
Returns the return value of the last operator if it was non-zero, or zero if all group members were processed. Otherwise returns a negative value. -
Non-C API(s): +
Fortran90 Interface:
There is no direct FORTRAN couterpart for the C function H5Giterate. Instead, that functionality is provided by two FORTRAN functions: -
- - - + +
- h5gn_members_f. + +
+ + + + + + + -
+ h5gn_members_f +    + Purpose: + Returns the number of group members. +
+ h5gget_obj_info_idx_f    Purpose: Returns the number of group members. @@ -772,15 +875,39 @@ create or access function.    Purpose: Returns name and type of the group member identified by its index. -
-
-
- +
+
+ + 
+SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr)           
+  IMPLICIT NONE
+  INTEGER(HID_T), INTENT(IN) :: loc_id        ! File or group identifier 
+  CHARACTER(LEN=*), INTENT(IN) :: name        ! Name of the group 
+  INTEGER, INTENT(OUT) :: nmembers            ! Number of members in the group
+  INTEGER, INTENT(OUT) :: hdferr              ! Error code 
+                                              ! 0 on success and -1 on failure
+END SUBROUTINE h5gn_members_f
+
+ + 
+SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, &
+                                 obj_name, obj_type, hdferr)           
+  IMPLICIT NONE
+  INTEGER(HID_T), INTENT(IN) :: loc_id        ! File or group identifier 
+  CHARACTER(LEN=*), INTENT(IN) :: name        ! Name of the group 
+  INTEGER, INTENT(IN) :: idx                  ! Index of member object 
+  CHARACTER(LEN=*), INTENT(OUT) :: obj_name   ! Name of the object 
+  INTEGER, INTENT(OUT) :: obj_type            ! Object type : 
+                                              !     H5G_LINK_F 
+                                              !     H5G_GROUP_F 
+                                              !     H5G_DATASET_F 
+                                              !     H5G_TYPE_F 
+  INTEGER, INTENT(OUT) :: hdferr              ! Error code 
+                                              ! 0 on success and -1 on failure
+END SUBROUTINE h5gget_obj_info_idx_f
+
@@ -832,13 +959,27 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -896,13 +1037,28 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -944,10 +1100,22 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -990,10 +1158,25 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1030,13 +1213,22 @@ create or access function.
Returns:
Returns a valid group identifier if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -1080,10 +1272,22 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1137,10 +1341,21 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1185,7 +1400,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 -- cgit v0.12