Purpose
|
Retrieves chunking information for a data set.
|
Return value
|
Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.
|
Description
|
SDgetchunkinfo retrieves chunking information about the data set identified by the parameter sds_id into the parameters cdef and flag in C, and to the parameters dim_length and flag in Fortran.
|
|
Currently, only information about chunk dimensions is retrieved into the corresponding cdef structure element for each type of compression in C, and in the dim_length array in Fortran. No information on compression parameters is available in the comp structure of the HDF_CHUNK_DEF union. Refer to the page on SDsetchunk in this manual for specific information on the HDF_CHUNK_DEF union.
|
|
The value returned in the flag parameter indicates the data set type (i.e., if the data set is not chunked, chunked, and chunked and compressed).
|
|
If the chunk length for each dimension is not needed, NULL can be passed in as the value of the cdef parameter in C.
|
|
The following table shows the type of the data set, possible values of the flag parameter, and the corresponding cdef structure element filled with the chunk's dimensions.
|