Sets the fill value for a dataset
Procedure:
H5P_SET_FILL_VALUE ( plist_id, type_id, value )
Signature:
herr_t H5Pset_fill_value(
hid_t plist_id,
hid_t type_id,
const void *value
)
Fortran90 Interface: h5pset_fill_value_f
Signature:
SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER(HID_T), INTENT(IN) :: type_id
TYPE(VOID) , INTENT(IN) :: fillvalue
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier
type_id - Datatype identifier of fill value datatype (in memory)
fillvalue - Fillvalue
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Fortran2003 Interface: h5pset_fill_value_f
Signature:
SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER(HID_T), INTENT(IN) :: type_id
TYPE(C_PTR) , INTENT(IN) :: fillvalue
INTEGER , INTENT(OUT) :: hdferr
Inputs:
prp_id - Property list identifier
type_id - Datatype identifier of fill value datatype (in memory)
fillvalue - Fillvalue
Outputs:
hdferr - Returns 0 if successful and -1 if fails
Parameters:
hid_t plist_id | IN: Dataset creation property list identifier |
hid_t type_id | IN: Datatype of value |
const void *value | IN: Pointer to buffer containing value to use as fill value |
Description:
H5P_SET_FILL_VALUE sets the fill value for a dataset in the dataset creation property list.
value
is interpreted as being of datatype type_id
. This datatype may differ from that of the dataset, but the HDF5 library must be able to convert value
to the dataset datatype when the dataset is created.
The default fill value is 0
(zero), which is interpreted according to the actual dataset datatype.
Setting value
to NULL
indicates that the fill value is to be undefined.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
status = H5Pset_fill_value (dcpl, H5T_NATIVE_INT, &fillval);
CALL h5pset_fill_value_f(dcpl, H5T_NATIVE_INTEGER, fillval, hdferr)
History:
Release | Change |
---|
1.8.8 | Fortran updated to Fortran2003. |
--- Last Modified: August 07, 2019 | 01:14 PM