Writes a raw data chunk from a buffer directly to a dataset in a file (DEPRECATED)
Procedure:
H5DO_WRITE_CHUNK (dset_id, dxpl_id, filter_mask, offset, data_size, buf)
Signature:
herr_t H5DOwrite_chunk( hid_t dset_id, hid_t dxpl_id, uint32_t filter_mask, hsize_t *offset, size_t data_size, const void *buf )
Parameters:
hid_t dset_id | IN: Identifier for the dataset to write to |
hid_t dxpl_id | IN: Transfer property list identifier for this I/O operation |
uint32_t filter_mask | IN: Mask for identifying the filters in use |
hsize_t *offset | IN: Logical position of the chunk’s first element in the dataspace |
size_t data_size | IN: Size of the actual data to be written in bytes |
const void *buf | IN: Buffer containing data to be written to the chunk |
Description:
H5DO_WRITE_CHUNK writes a raw data chunk as specified by its logical offset
in a chunked dataset dset_id
from the application memory buffer buf
to the dataset in the file. Typically, the data in buf
is preprocessed in memory by a custom transformation, such as compression. The chunk will bypass the library’s internal data transfer pipeline, including filters, and will be written directly to the file.
dxpl_id
is a data transfer property list identifier.
filter_mask
is a mask providing a record of which filters are used with the chunk. The default value of the mask is zero (0
), indicating that all enabled filters are applied. A filter is skipped if the bit corresponding to the filter’s position in the pipeline (0 ≤ position < 32
) is turned on. This mask is saved with the chunk in the file.
offset
is an array specifying the logical position of the first element of the chunk in the dataset’s dataspace. The length of the offset array must equal the number of dimensions, or rank, of the dataspace. The values in offset
must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary.
data_size
is the size in bytes of the chunk, representing the number of bytes to be read from the buffer buf
. If the data chunk has been precompressed, data_size
should be the size of the compressed data.
buf
is the memory buffer containing data to be written to the chunk in the file.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.10.3 | Function deprecated in favor of H5Dwrite_chunk . |
1.8.11 | C function introduced in this release. |
--- Last Modified: June 03, 2019 | 03:56 PM