You are viewing an old version of this page. View the current version.
Sets the file close degree
H5P_SET_FCLOSE_DEGREE ( fapl_id, fc_degree )
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
Replace this text with the C++ Function Signature
Replace this text with the JAVA Function Signature
|hid_t ||IN: File access property list identifier|
|H5F_close_degree_t ||IN: Pointer to a location containing the file close degree property, the value of |
H5P_SET_FCLOSE_DEGREE sets the file close degree property
fc_degree in the file access property list
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:
|Actual file is closed.||Access to file identifier is terminated; actual file close is delayed until all objects in file are closed|
|Actual file is closed.||Function returns FAILURE|
|Actual file is closed.||All open objects remaining in the file are closed then file is closed|
|The VFL driver chooses the behavior. Currently, all VFL drivers set this value to |
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
H5Fopen call with
H5F_CLOSE_STRONG will fail.
Returns a non-negative value if successful. Otherwise returns a negative value.
|1.6.0||Function introduced in this release.|