H5P_SET_DSET_NO_ATTRS_HINT
Sets the flag to create minimized dataset object headers
Procedure:
H5P_SET_DSET_NO_ATTRS_HINT ( dcpl_id, minimize )
Signature:
herr_t H5Pset_dset_no_attrs_hint(hid_t dcpl_id, hbool_t minimize)
Fortran Interface:
SUBROUTINE h5pset_dset_no_attrs_hint_f(dcpl_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: dcpl_id
LOGICAL , INTENT(IN) :: minimize
INTEGER , INTENT(OUT) :: hdferr
END SUBROUTINE h5pset_dset_no_attrs_hint_f
Parameters:
hid_t dcpl_id | IN: Dataset creation property list identifier |
hbool_t minimize | IN: Flag for indicating whether or not a dataset's object header will be minimized |
Description:
H5P_SET_DSET_NO_ATTRS_HINT sets the no dataset attributes hint setting for the dataset creation property list dcpl_id. Datasets created with the dataset creation property list dcpl_id will have their object headers minimized if the boolean flag minimize is set to TRUE. By setting minimize to TRUE, the library expects that no attributes will be added to the dataset -- attributes can be added, but they are appended with a continuation message, which can reduce performance.
This setting interacts with H5F_SET_DSET_NO_ATTRS_HINT: if either is set to TRUE, then the created dataset's object header will be minimized.
Returns:
Non-negative value (SUCCEED) if successful. Negative (FAIL) on failure.
Example:
hbool_t set;
hid_t dcpl_id;
dcpl_id = H5Pcreate(H5P_DATASET_CREATE);
assert(dcpl_id != H5I_INVALID_HID);
/* Get default value */
assert(H5Pget_dset_no_attrs_hint(dcpl_id, &set) == SUCCEED);
assert(set == FALSE);
/* Set to minimize (TRUE) */
assert(H5Pset_dset_no_attrs_hint(dcpl_id, TRUE) == SUCCEED);
/* Verify that the value has changed */
assert(H5Pget_dset_no_attrs_hint(dcpl_id, &set) == SUCCEED);
assert(set == TRUE);
History:
| Release | Change |
|---|
| 1.10.5 | Function introduced. |
--- Last Modified: February 05, 2019 | 12:14 PM
