H5F_GET_DSET_NO_ATTRS_HINT
Retrieves the setting for whether or not a file will create minimized dataset object headers
Procedure:
H5F_GET_DSET_NO_ATTRS_HINT ( file_id, minimize)
Signature:
herr_t H5Fget_dset_no_attrs_hint (hid_t file_id, hbool_t *minimize)
Fortran Interface:
SUBROUTINE h5fget_dset_no_attrs_hint_f(file_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: file_id
LOGICAL , INTENT(OUT) :: minimize
INTEGER , INTENT(OUT) :: hdferr
END SUBROUTINE h5fget_dset_no_attrs_hint_f
Parameters:
hid_t file_id | IN: File identifier (from H5F_OPEN or H5F_CREATE) |
hbool_t *minimize | OUT: Flag indicating whether the library will or will not create minimized dataset object headers |
Description:
H5F_GET_DSET_NO_ATTRS_HINT retrieves the no dataset attributes hint setting for the file specified by the file identifier file_id
. This setting is used to inform the library to create minimized dataset object headers when TRUE.
The setting's value is returned in the boolean pointer minimize
.
Returns:
Non-negative value (SUCCEED) if successful. Negative (FAIL) on failure.
Example:
hid_t file_id;
hbool_t set;
file_id = H5Fcreate("myfile", H5F_ACC_TRUNCATE, H5P_DEFAULT, H5P_DEFAULT);
assert(file_id != H5I_INVALID_FILE_ID);
assert(H5Fget_dset_no_attrs_hint(file_id, &set) == SUCCEED);
assert(set == FALSE);
History:
Release | Change |
---|
1.10.5 | Function introduced. |
--- Last Modified: February 05, 2019 | 12:11 PM