Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_FILL_VALUE

Retrieves a dataset fill value

Procedure:

H5P_GET_FILL_VALUE ( plist_id, type_id, value )

Signature:

herr_t H5Pget_fill_value(
        hid_t plist_id,
        hid_t type_id,
        void *value
    )
  

Fortran90 Interface: h5pget_fill_value_f
   
Signature:
  SUBROUTINE h5pget_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(OUT) :: fillvalue
    INTEGER       , INTENT(OUT) :: hdferr

Inputs:
  prp_id    - Property list identifier
  type_id   - Datatype identifier of fill value datatype (in memory)

Outputs:
  fillvalue - Fillvalue
  hdferr    - Returns 0 if successful and -1 if fails

  
Fortran2003 Interface: h5pget_fill_value_f
    
Signature:
  SUBROUTINE h5pget_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(OUT) :: fillvalue
    INTEGER       , INTENT(OUT) :: hdferr

Inputs:
  prp_id    - Property list identifier
  type_id   - Datatype identifier of fill value datatype (in memory)

Outputs:
  fillvalue - Fillvalue
  hdferr    - Returns 0 if successful and -1 if fails

Parameters:
hid_t plist_id    IN: Dataset creation property list identifier
hid_t type_idIN: Datatype identifier for the value passed via value
void *valueOUT: Pointer to buffer to contain the returned fill value

Description:

H5P_GET_FILL_VALUE returns the dataset fill value defined in the dataset creation property list plist_id.

The fill value is returned through the value pointer and will be converted to the datatype specified by type_id. This datatype may differ from the fill value datatype in the property list, but the HDF5 library must be able to convert between the two datatypes.

If the fill value is undefined, i.e., set to NULL in the property list, H5P_GET_FILL_VALUE will return an error. H5P_FILL_VALUE_DEFINED should be used to check for this condition before H5P_GET_FILL_VALUE is called.

Memory must be allocated by the calling application.

H5P_GET_FILL_VALUE is designed to coordinate with the dataset storage allocation time and fill value write time properties, which can be retrieved with the functions H5P_GET_ALLOC_TIME and H5P_GET_FILL_TIME, respectively.

 

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 | 02:04 PM