Sets the timing for storage space allocation


H5P_SET_ALLOC_TIME ( plist_id, alloc_time )


<pre><code class="language-c">herr_t H5Pset_alloc_time(hid_t plist_id,
            H5D_alloc_time_t alloc_time

<pre><code class="language-fortran">Fortran90 Interface: h5pset_alloc_time_f
SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr) 
  INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property
                                          ! list identifier
  INTEGER(HSIZE_T), INTENT(IN) :: flag    ! Allocation time flag
                                          ! Possible values are:
                                          !    H5D_ALLOC_TIME_ERROR_F
                                          !    H5D_ALLOC_TIME_DEFAULT_F
                                          !    H5D_ALLOC_TIME_EARLY_F
                                          !    H5D_ALLOC_TIME_LATE_F
                                          !    H5D_ALLOC_TIME_INCR_F
  INTEGER, INTENT(OUT)       :: hdferr    ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pset_alloc_time_f

hid_t plist_idIN: Dataset creation property list identifier
H5D_alloc_time_t alloc_time    IN: When to allocate dataset storage space


H5P_SET_ALLOC_TIME sets up the timing for the allocation of storage space for a dataset's raw data. This property is set in the dataset creation property list plist_id. Timing is specified in alloc_time with one of the following values:

H5D_ALLOC_TIME_DEFAULT  Allocate dataset storage space at the default time
(Defaults differ by storage method.)
H5D_ALLOC_TIME_EARLYAllocate all space when the dataset is created
(Default for compact datasets.)

Allocate space incrementally, as data is written to the dataset
(Default for chunked storage datasets.)

  • Chunked datasets: Storage space allocation for each chunk is deferred until data is written to the chunk.
  • Contiguous datasets: Incremental storage space allocation for contiguous data is treated as late allocation.
  • Compact datasets: Incremental allocation is not allowed with compact datasets; H5P_SET_ALLOC_TIME will return an error.

Allocate all space when data is first written to the dataset

(Default for contiguous datasets.)

H5P_SET_ALLOC_TIME is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions H5P_SET_FILL_VALUE and H5P_SET_FILL_TIME.

See H5D_CREATE for further cross-references.



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


Coming Soon!

Release    C
1.6.0Function introduced in this release.