Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Retrieves a dataset fill value

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_GET_FILL_VALUE ( plist_id, type_id, value )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Pget_fill_value(
        hid_t plist_id,
        hid_t type_id,
        void *value
    )
  </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">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
</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
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

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

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.

Note

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.

 

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.8.8Fortran updated to Fortran2003.