Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_FCLOSE_DEGREE

Sets the file close degree

Procedure:

H5P_SET_FCLOSE_DEGREE ( fapl_id, fc_degree )

Signature:

herr_t H5Pset_fclose_degree(
                      hid_t fapl_id, 
                      H5F_close_degree_t fc_degree
                      ) 

  

Fortran90 Interface: h5pset_fclose_degree_f
    
SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: fapl_id  ! File access property list identifier
  INTEGER, INTENT(IN) :: degree          ! Info about file close behavior 
                                         ! Possible values:
                                         !    H5F_CLOSE_DEFAULT_F
                                         !    H5F_CLOSE_WEAK_F
                                         !    H5F_CLOSE_SEMI_F
                                         !    H5F_CLOSE_STRONG_F
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pset_fclose_degree_f
    

Parameters:
hid_t fapl_idIN: File access property list identifier
H5F_close_degree_t fc_degree    IN: Pointer to a location containing the file close degree property, the value of fc_degree

Description:

H5P_SET_FCLOSE_DEGREE sets the file close degree property fc_degree in the file access property list fapl_id.

The value of fc_degree determines how aggressively H5F_CLOSE deals with objects within a file that remain open when H5F_CLOSE is called to close that file. fc_degree can have any one of four valid values:

Degree nameH5Fclose behavior with no open object in fileH5Fclose behavior with open object(s) in file
H5F_CLOSE_WEAKActual file is closed.Access to file identifier is terminated; actual file close is delayed until all objects in file are closed
H5F_CLOSE_SEMIActual file is closed.Function returns FAILURE
H5F_CLOSE_STRONGActual file is closed.All open objects remaining in the file are closed then file is closed
H5F_CLOSE_DEFAULTThe VFL driver chooses the behavior. Currently, all VFL drivers set this value to H5F_CLOSE_WEAK, except for the MPI-I/O driver, which sets it to H5F_CLOSE_SEMI.

Note that if a file is opened multiple times without being closed, each open operation must use the same file close degree setting. For example, if a file is already open with H5F_CLOSE_WEAK, an H5Fopen call with H5F_CLOSE_STRONG will fail.

 

Returns:

Returns a non-negative value if successful. Otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    C
1.6.0Function introduced in this release.

--- Last Modified: December 04, 2017 | 08:44 AM