The FORTRAN 90 API to HDF5
h5g: Groups

 

 


 

 

FORTRAN interface:   h5gclose_f
    
         SUBROUTINE h5gclose_f( gr_id, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: gr_id        ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gclose_f           

 

 


 

 

FORTRAN interface:   h5gcreate_f
    
         SUBROUTINE h5gcreate_f(loc_id, name, gr_id, hdferr, size_hint)

           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group to be created 
           INTEGER(HID_T), INTENT(OUT) :: gr_id       ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
           INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint  
                                       ! Number of bytes to store the names 
                                       ! of objects in the group. 
                                       ! Default value is OBJECT_NAMELEN_DEFAULT_F
         END SUBROUTINE h5gcreate_f           

 

 


 

 

FORTRAN interface:   h5gget_comment_f
    
         SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object link 
           CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold a
                                                        ! comment  
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gget_comment_f           

 

 


 

 

FORTRAN interface:   h5gget_linkval_f
    
         SUBROUTINE h5gget_linkval_f(loc_id, name, size, buffer, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the symbolic link 
           CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold a
                                                        ! name of the object 
                                                        ! symbolic link points to
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gget_linkval_f           

 

 


 

 

FORTRAN interface:   h5gget_obj_info_idx_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

 

 


 

 

FORTRAN interface:   h5gmove_f
    
         SUBROUTINE h5gmove_f(loc_id, name, new_name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Original name of an object 
           CHARACTER(LEN=*), INTENT(IN) :: new_name   ! New name of an object 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gmove_f           

 

 


 

 

FORTRAN interface:   h5gmove_f
    
         SUBROUTINE h5gmove2_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: src_loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: src_name   ! Original name of an object 
                                                      ! relative to src_loc_id 
           INTEGER(HID_T), INTENT(IN) :: dst_loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: dst_name   ! New name of an object
                                                      ! relative to dst_loc_id 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gmove2_f           

 

 


 

 

FORTRAN interface:   h5gn_members_f
    
          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

 

 


 

 

FORTRAN interface:   h5gopen_f
    
         SUBROUTINE h5gopen_f(loc_id, name, gr_id, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group to open 
           INTEGER(HID_T), INTENT(OUT) :: gr_id   ! Group identifier
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gopen_f           

 

 


 

 

FORTRAN interface:   h5gset_comment_f
    
         SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of object 
           CHARACTER(LEN=*), INTENT(IN) :: comment   ! Comment for the object 
           INTEGER, INTENT(OUT) :: hdferr        ! Error code 
                                                 ! 0 on success and -1 on failure
         END SUBROUTINE h5gset_comment_f           

 

 


 

 

FORTRAN interface:   h5glink_f
Purpose: Creates a link of the specified type from new_name to current_name.
          SUBROUTINE h5glink_f(loc_id, link_type, current_name, new_name, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: loc_id    ! File or group location identifier
            INTEGER, INTENT(IN)        :: link_type ! Link type, possible values are:
                                                    !  H5G_LINK_HARD_F
                                                    !  H5G_LINK_SOFT_F
            CHARACTER(LEN=*), INTENT(IN) :: current_name ! Current object name relative
                                                         ! to loc_id 
            CHARACTER(LEN=*), INTENT(IN) :: new_name     ! New object name 
            INTEGER, INTENT(OUT) :: hdferr          ! Error code

          END SUBROUTINE h5glink_f

 

 


 

 

FORTRAN interface:   h5glink2_f
Purpose: Creates a link of the specified type from new_name at location new_loc_id,/code> to cur_name at location cur_loc_id.
          SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN)   :: cur_loc_id ! File or group location identifier
            CHARACTER(LEN=*), INTENT(IN) :: cur_name
                                           ! Name of the existing object
                                           ! is relative to cur_loc_id. Can be
                                           ! anything for the soft link.
            INTEGER, INTENT(IN) :: link_type ! Link type, possible values are:
                                             !  H5G_LINK_HARD_F
                                             !  H5G_LINK_SOFT_F
            INTEGER(HID_T), INTENT(IN) :: new_loc_id ! New location identifier
            CHARACTER(LEN=*), INTENT(IN) :: new_name ! New object name 
            INTEGER, INTENT(OUT) :: hdferr          ! Error code

          END SUBROUTINE h5glink2_f

 

 


 

 

FORTRAN interface:   h5gunlink_f
    
         SUBROUTINE h5gunlink_f(loc_id, name, hdferr)
           IMPLICIT NONE
           INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object to unlink 
           INTEGER, INTENT(OUT) :: hdferr         ! Error code 
                                                  ! 0 on success and -1 on failure
         END SUBROUTINE h5gunlink_f           

 

 


HDF Help Desk
Describes HDF5 Release 1.6.0, July 2003
Last modified: 5 March 2003