From e67fc6a10ce62be9bbd5ec03ca965e6df1743421 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Mon, 13 Oct 2003 17:15:49 -0500 Subject: [svn-r7620] Purpose: Integrate Fortran90 interfaces into C RM. (Cleanup pass for H5A and H5D, initially checked in last week.) Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari --- doc/html/RM_H5A.html | 48 +++---- doc/html/RM_H5D.html | 215 +++++++++++++++------------- doc/html/RM_H5E.html | 155 ++++++++++++++------ doc/html/RM_H5F.html | 320 +++++++++++++++++++++++++++++++++-------- doc/html/RM_H5G.html | 391 +++++++++++++++++++++++++++++++++++++++------------ doc/html/RM_H5I.html | 50 +++++-- doc/html/RM_H5R.html | 129 ++++++++++++++--- 7 files changed, 967 insertions(+), 341 deletions(-) diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index 516e979..3bf8492 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -305,7 +305,8 @@ END SUBROUTINE h5aclose_f
Fortran90 Interface: h5acreate_f
-SUBROUTINE h5acreate_f(obj_id, name, type_id, space_id, attr_id, & hdferr, creation_prp) 
+SUBROUTINE h5acreate_f(obj_id, name, type_id, space_id, attr_id, & 
+                       hdferr, creation_prp) 
   IMPLICIT NONE
   INTEGER(HID_T), INTENT(IN) :: obj_id    ! Object identifier 
   CHARACTER(LEN=*), INTENT(IN) :: name    ! Attribute name
@@ -783,21 +784,20 @@ END SUBROUTINE h5aopen_name_f
 	
 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
+  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
+                                           ! Array to hold corresponding 
+                                           ! dimension sizes of data buffer buf;
+                                           ! buf; dim(k) has value of the 
+                                           ! k-th dimension of buffer buf;
+                                           ! values are ignored if buf is a 
+                                           ! scalar
+  INTEGER, INTENT(OUT) :: hdferr           ! Error code
+                                           ! 0 on success and -1 on failure
 END SUBROUTINE h5aread_f
 	
@@ -854,16 +854,14 @@ SUBROUTINE h5awrite_f(attr_id, memtype_id, buf, dims, hdferr) 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 + 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) + ! 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 INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5awrite_f @@ -916,7 +914,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 71ac11c..86ee6dc 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -407,12 +407,12 @@ END SUBROUTINE h5dcreate_f
 SUBROUTINE h5dextend_f(dataset_id, size, hdferr) 
   IMPLICIT NONE 
-  INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
+  INTEGER(HID_T), INTENT(IN) :: dataset_id   ! Dataset identifier
   INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN)  :: size
-                                                ! Array containing 
-                                                ! dimensions' sizes 
-  INTEGER, INTENT(OUT) :: hdferr                ! Error code 
-                                                ! 0 on success and -1 on failure
+                                             ! Array containing 
+                                             ! dimensions' sizes 
+  INTEGER, INTENT(OUT) :: hdferr             ! Error code 
+                                             ! 0 on success and -1 on failure
 END SUBROUTINE h5dextend_f 
 	
@@ -496,7 +496,8 @@ SUBROUTINE h5dfill_f(fill_value, space_id, buf, hdferr) IMPLICIT NONE TYPE, INTENET(IN) :: fill_value ! Fill value; may be have one of the ! following types: - ! INTEGER, REAL, DOUBLE PRECISION, CHARACTER + ! INTEGER, REAL, DOUBLE PRECISION, + ! CHARACTER INTEGER(HID_T), INTENT(IN) :: space_id ! Memory dataspace selection identifier TYPE, DIMENSION(*) :: buf ! Memory buffer to fill in; must have ! the same datatype as fill value @@ -542,11 +543,11 @@ END SUBROUTINE h5dfill_f
 SUBROUTINE h5dget_create_plist_f(dataset_id, creation_prp, hdferr) 
   IMPLICIT NONE 
-  INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-  INTEGER(HID_T), INTENT(OUT) :: creation_id    ! Dataset creation
-                                                ! property list identifier
-  INTEGER, INTENT(OUT) :: hdferr                ! Error code 
-                                                ! 0 on success and -1 on failure
+  INTEGER(HID_T), INTENT(IN) :: dataset_id    ! Dataset identifier
+  INTEGER(HID_T), INTENT(OUT) :: creation_id  ! Dataset creation
+                                              ! property list identifier
+  INTEGER, INTENT(OUT) :: hdferr              ! Error code 
+                                              ! 0 on success and -1 on failure
 END SUBROUTINE h5dget_create_plist_f  
 
 	
@@ -739,7 +740,8 @@ END SUBROUTINE h5dget_space_status_f SUBROUTINE h5dget_storage_size_f(dset_id, size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier - INTEGER(HSIZE_T), INTENT(OUT) :: size ! Amount of storage required for dataset + INTEGER(HSIZE_T), INTENT(OUT) :: size ! Amount of storage required + ! for dataset INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5dget_storage_size_f @@ -785,10 +787,10 @@ END SUBROUTINE h5dget_storage_size_f
 SUBROUTINE h5dget_type_f(dataset_id, datatype_id, hdferr) 
   IMPLICIT NONE 
-  INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-  INTEGER(HID_T), INTENT(OUT) :: datatype_id    ! Datatype identifier
-  INTEGER, INTENT(OUT) :: hdferr                ! Error code 
-                                                ! 0 on success and -1 on failure
+  INTEGER(HID_T), INTENT(IN) :: dataset_id    ! Dataset identifier
+  INTEGER(HID_T), INTENT(OUT) :: datatype_id  ! Datatype identifier
+  INTEGER, INTENT(OUT) :: hdferr              ! Error code 
+                                              ! 0 on success and -1 on failure
 END SUBROUTINE h5dget_type_f 
 	
@@ -1072,72 +1074,77 @@ END SUBROUTINE h5dopen_f
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Fortran90 Interface: h5dread_f (for all datatypes except object and dataset region references) -
+
Fortran90 Interface: h5dread_f + +
There are seperate versions of this interface. + Their use depends on the datatype of the object being read. + +

Use the following h5dread_f call for + all datatypes except object and dataset region references: + +

 SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, &
                      mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: dset_id         ! Dataset identifier
-  INTEGER(HID_T), INTENT(IN) :: mem_type_id     ! Memory datatype identifier
-  TYPE, INTENT(INOUT) :: buf                    ! Data buffer; may be a scalar or an array
+  INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
+  INTEGER(HID_T), INTENT(IN) :: mem_type_id  ! Memory datatype identifier
+  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)     
+                                             ! 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
   INTEGER, INTENT(OUT) :: hdferr      ! Error code 
-                                                ! 0 on success and -1 on failure
+                                             ! 0 on success and -1 on failure
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id 
-                                                ! Memory dataspace identfier 
-                                                ! Default value is H5S_ALL_F 
+                                             ! Memory dataspace identfier 
+                                             ! Default value is H5S_ALL_F 
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id 
-                                                ! File dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! File dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp 
-                                                ! Transfer property list identifier 
-                                                ! Default value is H5P_DEFAULT_F 
-            
+                                             ! Transfer property list identifier
+                                             ! Default value is H5P_DEFAULT_F             
 END SUBROUTINE h5dread_f
 	
-
Fortran90 Interface: h5dread_f (for object reference and dataset region reference datatypes) -
+

Use this h5dread_f call for + object reference and dataset region reference datatypes: +

 SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, &
                      mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: dset_id         ! Dataset identifier
-  INTEGER(HID_T), INTENT(IN) :: mem_type_id     ! Memory datatype identifier
+  INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
+  INTEGER(HID_T), INTENT(IN) :: mem_type_id  ! Memory datatype identifier
   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, DIMENSION(7), 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
   TYPE(hobj_ref_t_f), DIMENSION(dims(1)), INTENT(INOUT) :: buf
-                                                ! Data buffer of rank 1
+                                             ! Data buffer of rank 1
   INTEGER, INTENT(OUT) :: hdferr      ! Error code 
-                                                ! 0 on success and -1 on failure
+                                             ! 0 on success and -1 on failure
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id 
-                                                ! Memory dataspace identfier 
-                                                ! Default value is H5S_ALL_F 
+                                             ! Memory dataspace identfier 
+                                             ! Default value is H5S_ALL_F 
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id 
-                                                ! File dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! File dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp 
-                                                ! Transfer property list identifier 
-                                                ! Default value is H5P_DEFAULT_F 
-            
+                                             ! Transfer property list identifier
+                                             ! Default value is H5P_DEFAULT_F             
 END SUBROUTINE h5dread_f
 	
@@ -1449,72 +1456,78 @@ SUBROUTINE
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Fortran90 Interface: h5dwrite_f (for all datatypes except object and dataset region references) -
+
Fortran90 Interface: h5dwrite_f + +
There are seperate versions of this interface. + Their use depends on the datatype of the object being written. + +

Use the following h5dwrite_f call for all + datatypes except object and dataset region references: + +

 SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, &
                       mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: dset_id         ! Dataset identifier
-  INTEGER(HID_T), INTENT(IN) :: mem_type_id     ! Memory datatype identifier
-  TYPE, INTENT(IN) :: buf                       ! Data buffer; may be a scalar or an array
+  INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
+  INTEGER(HID_T), INTENT(IN) :: mem_type_id  ! Memory datatype identifier
+  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)     
+                                             ! 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
   INTEGER, INTENT(OUT) :: hdferr      ! Error code 
-                                                ! 0 on success and -1 on failure
+                                             ! 0 on success and -1 on failure
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id 
-                                                ! Memory dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! Memory dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id 
-                                                ! File dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! File dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp 
-                                                ! Transfer property list identifier 
-                                                ! Default value is H5P_DEFAULT_F 
+                                             ! Transfer property list 
+                                             ! identifier; default value 
+                                             ! is H5P_DEFAULT_F 
             
 END SUBROUTINE h5dwrite_f
-
 	
- -
Fortran90 Interface: h5dwrite_f (for object reference and dataset region reference datatypes) -
+ +

Use the following h5dwrite_f call for object reference + and dataset region reference datatypes: +

 SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, &
                       mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: dset_id         ! Dataset identifier
-  INTEGER(HID_T), INTENT(IN) :: mem_type_id     ! Memory datatype identifier
+  INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
+  INTEGER(HID_T), INTENT(IN) :: mem_type_id  ! Memory datatype identifier
   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, DIMENSION(7), INTENT(IN) :: dims
+                                             ! Array to hold corresponding 
+                                             ! dimension sizes of data 
+                                             ! buffer buf 
+                                             ! dim(k) has valueof the k-th 
+                                             ! dimension of buffer buf; 
+                                             ! values are ignored if buf
+                                             ! is a scalar
   TYPE(hobj_ref_t_f), DIMENSION(dims(1)), INTENT(INOUT) :: buf
-                                                ! Data buffer of rank 1
+                                             ! Data buffer of rank 1
   INTEGER, INTENT(OUT) :: hdferr      ! Error code 
-                                                ! 0 on success and -1 on failure
+                                             ! 0 on success and -1 on failure
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id 
-                                                ! Memory dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! Memory dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id 
-                                                ! File dataspace identfier 
-                                                ! Default value is H5S_ALL_F
+                                             ! File dataspace identfier 
+                                             ! Default value is H5S_ALL_F
   INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp 
-                                                ! Transfer property list identifier 
-                                                ! Default value is H5P_DEFAULT_F 
+                                             ! Transfer property list identifier
+                                             ! Default value is H5P_DEFAULT_F 
             
 END SUBROUTINE h5dwrite_f
 	
@@ -1566,7 +1579,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index e5fa126..deb508c 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -216,10 +216,19 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -253,12 +262,18 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + - + + @@ -285,10 +300,20 @@ errors within the H5E package.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." -
Non-C API(s): -
- @@ -315,10 +340,20 @@ errors within the H5E package.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." -
Non-C API(s): -
- @@ -351,10 +386,19 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -407,12 +451,18 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + - + + @@ -453,10 +503,23 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -531,12 +594,18 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + - + + @@ -589,12 +658,18 @@ errors within the H5E package.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + - + + diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index d021724..48563fe 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -240,10 +240,20 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -348,10 +358,39 @@ facilitate moving easily between them.
Returns:
Returns a file identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -405,10 +444,23 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -442,10 +494,22 @@ facilitate moving easily between them.
Returns:
Returns a file access property list identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -482,15 +546,29 @@ facilitate moving easily between them.
Returns:
Returns a file creation property list identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- +
@@ -517,10 +595,25 @@ facilitate moving easily between them.
Returns:
Returns a the amount of free space in the file if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -597,10 +690,28 @@ facilitate moving easily between them.
Returns:
Returns a the number of open objects if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -650,10 +761,32 @@ facilitate moving easily between them.
Returns:
Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -703,11 +836,18 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + @@ -735,10 +875,23 @@ facilitate moving easily between them.
When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -782,10 +935,22 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -882,10 +1047,29 @@ facilitate moving easily between them.
Returns:
Returns a file identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -927,10 +1111,21 @@ facilitate moving easily between them.
Returns:
Returns a new file identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -973,10 +1168,21 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1024,7 +1230,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 4ec64bf..2476b4b 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -234,13 +234,20 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -295,13 +302,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 +370,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 +439,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 +487,21 @@ create or access function.
Returns:
Returns positive value if successful; otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + + @@ -560,12 +624,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. + - + + @@ -625,6 +695,21 @@ create or access function.
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. + + + + @@ -708,6 +793,21 @@ create or access function.
Returns:
Returns the type of the object if successful. Otherwise returns a negative value. +
Fortran90 Interface: +
None. + + + + @@ -785,35 +885,62 @@ 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. -    - Purpose: - Returns the number of group members. -
- h5gget_obj_info_idx_f + +
+ + + + + + + -
+ h5gn_members_f +    + Purpose: + Returns the number of group members. +
+ h5gget_obj_info_idx_f    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
+		
@@ -865,13 +992,27 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -929,13 +1070,28 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -977,10 +1133,22 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1023,10 +1191,25 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1063,13 +1246,22 @@ create or access function.
Returns:
Returns a valid group identifier if successful; otherwise returns a negative value. -
Non-C API(s): - -
- @@ -1113,10 +1305,22 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1170,10 +1374,21 @@ create or access function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -1218,7 +1433,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 409de63..2f3d73b 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -174,10 +174,23 @@ facilitate moving easily between them.
Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value. -
Non-C API(s): -
- @@ -230,10 +243,29 @@ facilitate moving easily between them.
Returns:
Returns the object type if successful; otherwise H5I_BADID. -
Non-C API(s): -
- @@ -278,7 +310,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index c1b95a8..7465b09 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -224,10 +224,40 @@ facilitate moving easily between them.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -268,10 +298,38 @@ facilitate moving easily between them.
Returns:
Returns valid identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -341,10 +399,27 @@ facilitate moving easily between them.
Returns:
Returns an object type as defined in H5Gpublic.h if successful; otherwise returns H5G_UNKNOWN. -
Non-C API(s): -
- @@ -388,10 +463,10 @@ facilitate moving easily between them.
Returns:
Returns an object type as defined in H5Gpublic.h; otherwise returns H5G_UNKNOWN. -
Non-C API(s): -
- @@ -433,10 +508,22 @@ facilitate moving easily between them.
Returns:
Returns a valid identifier if successful; otherwise returns a negative value. -
Non-C API(s): -
- @@ -481,7 +568,7 @@ And in this document, the Describes HDF5 Release 1.6.0, July 2003 -- cgit v0.12