[Top]
[Prev]
[Next]
[Bottom]
SDgetchunkinfo
intn SDgetchunkinfo(int32
sds_id
, HDF_CHUNK_DEF *
cdef
, int32 *
flags
)
sds_id
IN:
Dataset identifier returned from
SDselect
cdef
OUT:
Union structure containing information about the chunks in the SDS
flags
OUT:
Flags determining routine behavior
Purpose
Obtains chunking information about a scientific dataset.
Return value
Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.
Description
A pointer to a chunk_lengths array (defined in the comp_info union pointed to by
cdef
) containing chunk dimension size information will be returned if the value of flags is HDF_CHUNK, and a pointer to a comp_info structure containing the dimension size of the chunks and compression information will be returned if the value of flags is HDF_CHUNK bitwise-OR'ed with HDF_COMP.
For the definition of the HDF_CHUNK_DEF union, refer to the Reference Manual page for
SDsetchunk
.
SDgetchunkinfo
can also be used to determine if the target SDS is not chunked. In this case, the value of flags is set to HDF_NONE and the
cdef
parameter is ignored.
A NULL value can also be passed in as the cdef parameter if chunking information is not desired.
[Top]
[Prev]
[Next]
[Bottom]
hdfhelp@ncsa.uiuc.edu
HDF User's Reference Manual, Draft 06/09/97, NCSA HDF Development Group.