Retrieves information about a chunk specified by the chunk index

Procedure:

H5D_GET_CHUNK_INFO (dset_id, fspace_id, index, offset, filter_mask, addr, size)

Signature:

<pre><code class="language-c">
herr_t H5Dget_chunk_info (hid_t dset_id, hid_t fspace_id, hsize_t index,hsize_t *offset, unsigned *filter_mask, haddr_t *addr, hsize_t *size)
</code></pre>

<pre><code class="language-fortran">Replace this text with the Fortran function signature</code></pre>

Parameters:

hid_t dset_id    

IN: Dataset identifier

hid_t fspace_id

IN: File dataspace selection identifier; H5S_ALL if the selection is the current extent of the dataset (See NOTE below)

hsize_t index

IN: Chunk index in the selection. Index value may have a value of 0 up to the number of chunks stored in the file that have a nonempty intersection with the file dataspace selection

hsize_t *offset

OUT: Pointer to a one-dimensional array with a size equal to the dataset’s rank. When the function returns, the array’s elements contain 0-based logical positions of the chunk’s first element in each dimension.

unsigned *filter_mask

OUT: Filter mask that indicates which filters were used with the chunk when written. A zero value indicates that all enabled filters are applied on the chunk. A filter is skipped if the bit corresponding to the filter’s position in the pipeline (0 ≤ position < 32) is turned on.

haddr_t *addr

OUT: Chunk address in the file

hsize_t *size

OUT: Chunk size in bytes

 

Description:

H5D_GET_CHUNK_INFO retrieves the offset coordinates offset, filter mask filter_mask, size size and address addr for the dataset specified by the identifier dset_id and the chunk specified by the index index. The chunk belongs to a set of chunks in the selection specified by fspace_id. If the queried chunk does not exist in the file, the size will be set to 0 and address to HADDR_UNDEF. The value pointed to by filter_mask will not be modified. NULL can be passed in for any OUT parameters.

NOTE: Please be aware that in HDF5-1.10.5, the dataspace intersection was not yet completed, and the index is of all the written chunks.

Returns:

Returns a non-negative value if successful. Otherwise returns a negative value.

Example:

Coming Soon!

History:
ReleaseChange
1.10.5C function introduced