Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_SET_FILL_VALUE

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_idIN: Dataset creation property list identifier
hid_t type_idIN: 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.

Applications sometimes write data only to portions of an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. This function allows the user application to set that fill value; the functions H5D_FILL and H5P_SET_FILL_TIME, respectively, provide the ability to apply the fill value on demand or to set up its automatic application.

A fill value should be defined so that it is appropriate for the application. While the HDF5 default fill value is 0 (zero), it is often appropriate to use another value. It might be useful, for example, to use a value that is known to be impossible for the application to legitimately generate.

H5P_SET_FILL_VALUE is designed to work in concert with H5P_SET_ALLOC_TIME and H5P_SET_FILL_TIME. H5P_SET_ALLOC_TIME and H5P_SET_FILL_TIME govern the timing of dataset storage allocation and fill value write operations and can be important in tuning application performance.

See H5D_CREATE for further cross-references.

 

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.8.8Fortran updated to Fortran2003.

--- Last Modified: December 15, 2017 | 01:55 PM