H5Dget_storage_size
(
hid_t dataset_id
)
H5Dget_storage_size
returns the amount of storage
that is required to write the raw data of the dataset specified by
dataset_id
.
For contiguous datasets, the returned size reflects the allocated size of the raw data.
For unfiltered chunked datasets, the returned size is the number of allocated chunks times the chunk size.
For filtered chunked datasets, the returned size is
the space required to store the filtered data.
For example, if a compression filter is in use,
H5Dget_storage_size
returns the space required
to store the compressed chunks.
H5Dget_storage_size
reports only the space required
to store the data; the report does not include any metadata.
The return value may be zero if no data has been stored.
hid_t dataset_id |
IN: Identifier of the dataset to query. |
H5Dget_storage_size
does not differentiate between
0
(zero), the value returned for the storage size of a
dataset with no stored values, and
0
(zero), the value returned to indicate an error.
SUBROUTINE h5dget_storage_size_f(dset_id, size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier INTEGER(HSIZE_T), INTENT(OUT) :: size ! Amount of storage required ! for dataset INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5dget_storage_size_f
Release | Fortran90 |
1.4.5 | Function introduced in this release. |