Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5D_EXTEND

Extends a dataset

This function is deprecated in favor of the function H5D_SET_EXTENT.

 

Procedure:

H5D_EXTEND(dataset_id, size)

Signature:

herr_t H5Dextend
(
    hid_t dataset_id,
    const hsize_t size[]
)

SUBROUTINE h5dextend_f(dataset_id, size, hdferr) 
  IMPLICIT NONE 
  INTEGER(HID_T), INTENT(IN) :: dataset_id   ! Dataset identifier
  INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN)  :: size
                                             ! Array containing 
                                             ! dimensions' sizes 
  INTEGER, INTENT(OUT) :: hdferr             ! Error code 
                                             ! 0 on success and -1 on failure
END SUBROUTINE h5dextend_f

Parameters:
hid_t dataset_idIN: Identifier of the dataset
const hsize_t size[]    IN: Array containing the new magnitude of each dimension

Description:

H5D_EXTEND verifies that the dataset is at least of size size, extending it if necessary. The dimensionality of size is the same as that of the dataspace of the dataset being changed.

This function can be applied to the following datasets:

  • Any dataset with unlimited dimensions
  • A dataset with fixed dimensions if the current dimension sizes are less than the maximum sizes set with maxdims (see H5S_CREATE_SIMPLE)

Space on disk is immediately allocated for the new dataset extent if the dataset’s space allocation time is set to H5D_ALLOC_TIME_EARLY. Fill values will be written to the dataset if the dataset’s fill time is set to H5D_FILL_TIME_IFSET or H5D_FILL_TIME_ALLOC. (See H5P_SET_FILL_TIME and H5P_SET_ALLOC_TIME.)

This function ensures that the dataset dimensions are of at least the sizes specified in size. The function H5D_SET_EXTENT must be used if the dataset dimension sizes are are to be reduced.

Returns:

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

Example:

Coming Soon!

History:
Release    C
1.8.0Function deprecated in this release.
1.8.0Parameter size syntax changed to 'const hsize_t size[]' in this release.

--- Last Modified: April 10, 2018 | 03:46 PM