The FORTRAN 90 API to HDF5
h5f: Files

 

 


 

 

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

 

 


 

 

FORTRAN interface:   h5fcreate_f
         SUBROUTINE h5fcreate_f(name, access_flags, file_id, hdferr, &  
                                creation_prp, access_prp)
           IMPLICIT NONE 
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
           INTEGER, INTENT(IN) :: access_flag     ! File access flags 
                                                  ! Possible values are:
                                                  ! H5F_ACC_RDWR_F   
                                                  ! H5F_ACC_RDONLY_F   
                                                  ! H5F_ACC_TRUNC_F  
                                                  ! H5F_ACC_EXCL_F    
                                                  ! H5F_ACC_DEBUG_F   
           INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier 
           INTEGER, INTENT(OUT) :: hdferr         ! Error code 
                                                  ! 0 on success and -1 on failure
           INTEGER(HID_T), OPTIONAL, INTENT(IN) :: creation_prp 
                                                  ! File creation propertly 
                                                  ! list identifier, if not 
                                                  ! specified its value is
                                                  ! H5P_DEFAULT_F  
           INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp  
                                                  ! File access property list 
                                                  ! identifier, if not 
                                                  ! specified its value is
                                                  ! H5P_DEFAULT_F  
         END SUBROUTINE h5fcreate_f 

 

 


 

 

FORTRAN interface:   h5fis_hdf5_f
         SUBROUTINE h5fis_hdf5_f(name, status, hdferr)   
           IMPLICIT NONE 
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
           LOGICAL, INTENT(OUT) :: status         ! This parameter
                                                  ! indicates if file is 
                                                  ! an HDF5 file 
                                                  ! ( TRUE or FALSE ) 
           INTEGER, INTENT(OUT) :: hdferr         ! Error code 
                                                  ! 0 on success and -1 on failure
         END SUBROUTINE h5fis_hdf5_f 

 

 


 

 

FORTRAN interface:   h5fopen_f
         SUBROUTINE h5fopen_f(name, access_flags, file_id, hdferr, &  
                              access_prp)
           IMPLICIT NONE 
           CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
           INTEGER, INTENT(IN) :: access_flag     ! File access flags  
                                                  ! Possible values are:
                                                  ! H5F_ACC_RDWR_F   
                                                  ! H5F_ACC_RDONLY_F    
           INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier 
           INTEGER, INTENT(OUT) :: hdferr         ! Error code 
                                                  ! 0 on success and -1 on failure
           INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp  
                                                  ! File access property list 
                                                  ! identifier  
         END SUBROUTINE h5fopen_f 

 

 


 

 

FORTRAN interface:   h5freopen_f
         SUBROUTINE h5freopen_f(file_id, new_file_id, hdferr)
           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)  :: file_id     ! File identifier 
           INTEGER(HID_T), INTENT(OUT) :: new_file_id ! New file identifier 
           INTEGER, INTENT(OUT)        :: hdferr      ! Error code 
                                                      ! 0 on success and -1 on failure
         END SUBROUTINE h5freopen_f 

 

 


 

 

FORTRAN interface:   h5fflush_f
         SUBROUTINE h5fflush_f(obj_id, new_file_id, hdferr)
           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)  :: obj_id      ! Object identifier
           INTEGER, INTENT(IN)         :: scope       ! Flag with two possible values:
                                                      ! H5F_SCOPE_GLOBAL_F  
                                                      ! H5F_SCOPE_LOCAL_F  
           INTEGER, INTENT(OUT)        :: hdferr      ! Error code 
                                                      ! 0 on success and -1 on failure
         END SUBROUTINE h5fflush_f 

 

 


 

 

FORTRAN interface:   h5fmount_f
         SUBROUTINE h5fmount_f(loc_id, name, child_id, hdferr)
           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)  :: loc_id      ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN):: name        ! Group name at locationloc_id
           INTEGER(HID_T), INTENT(IN)  :: child_id    ! File(to be mounted) identifier
           INTEGER, INTENT(OUT)        :: hdferr      ! Error code 
                                                      ! 0 on success and -1 on failure
         END SUBROUTINE h5fmount_f 

 

 


 

 

FORTRAN interface:   h5funmount_f
         SUBROUTINE h5funmount_f(loc_id, name, child_id, hdferr)
           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)  :: loc_id      ! File or group identifier
           CHARACTER(LEN=*), INTENT(IN):: name        ! Group name at location loc_id
           INTEGER, INTENT(OUT)        :: hdferr      ! Error code 
                                                      ! 0 on success and -1 on failure
         END SUBROUTINE h5funmount_f 

 

 


 

 

FORTRAN interface:   h5fget_create_plist_f
         SUBROUTINE h5fget_create_plist_f(file_id, fcpl_id, hdferr)

           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)   :: file_id ! File identifier
           INTEGER(HID_T), INTENT(OUT)  :: fcpl_id ! File creation property list identifier
           INTEGER, INTENT(OUT)         :: hdferr  ! Error code 
                                                   ! 0 on success and -1 on failure
         END SUBROUTINE h5fget_create_plist_f 

 

 


 

 

FORTRAN interface:   h5fget_access_plist_f
         SUBROUTINE h5fget_access_plist_f(file_id, fcpl_id, hdferr)

           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)   :: file_id ! File identifier
           INTEGER(HID_T), INTENT(OUT)  :: fapl_id ! File access property list identifier
           INTEGER, INTENT(OUT)         :: hdferr  ! Error code 
                                                   ! 0 on success and -1 on failure
         END SUBROUTINE h5fget_access_plist_f 

 

 


 

 

FORTRAN interface:   h5fget_obj_count_f
         SUBROUTINE h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)

           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)  :: file_id  ! File identifier
           INTEGER, INTENT(IN)         :: obj_type ! Object types, possible values are:
						    ! H5F_OBJ_FILE_F
						    ! H5F_OBJ_GROUP_F
						    ! H5F_OBJ_DATASET_F
						    ! H5F_OBJ_DATATYPE_F
						    ! H5F_OBJ_ALL_F
           INTEGER, INTENT(OUT)        :: obj_count ! number of opened objects
           INTEGER, INTENT(OUT)        :: hdferr    ! Error code 
                                                    ! 0 on success and -1 on failure
         END SUBROUTINE h5fget_obj_count_f 

 

 


 

 

FORTRAN interface:   h5fget_obj_ids_f
         SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr)

           IMPLICIT NONE 
           INTEGER(HID_T), INTENT(IN)   :: file_id  ! File identifier
           INTEGER,        INTENT(IN)   :: obj_type ! Object types, possible values are:
						    ! H5F_OBJ_FILE_F
						    ! H5F_OBJ_GROUP_F
						    ! H5F_OBJ_DATASET_F
						    ! H5F_OBJ_DATATYPE_F
						    ! H5F_OBJ_ALL_F
           INTEGER, INTENT(IN)          :: max_objs ! Maximum # of object IDs to retrieve
           INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: obj_ids
                                                    ! array of requested object identifiers
           INTEGER, INTENT(OUT)        :: hdferr    ! Error code 
                                                    ! 0 on success and -1 on failure
         END SUBROUTINE h5fget_obj_ids_f 

 

 


HDF Help Desk
Describes HDF5 Release 1.5, Unreleased Development Branch
Last modified: 30 September, 2002