Returns the amount of free space in a file
Procedure:
H5F_GET_FREESPACE(file_id)
Signature:
hssize_t H5Fget_freespace( hid_t file_id )
SUBROUTINE h5fget_freespace_f(file_id, free_space, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER(HSSIZE_T), INTENT(OUT) :: free_space ! Amount of free space in file
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_freespace_f
Parameters:
hid_t file_id | IN: Identifier of a currently-open HDF5 file |
Description:
Given the identifier of an open file, file_id, H5F_GET_FREESPACE returns the amount of space that is unused by any objects in the file.
Currently, the HDF5 library only tracks free space in a file from a file open or create until that file is closed, so this routine will only report the free space that has been created during that interval.
Returns:
Returns the amount of free space in the file if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.6.1 | Function introduced in this release. |
--- Last Modified: December 20, 2018 | 01:49 PM
