Retrieving the Data Space Dimensionality
Function Syntax
Retrieve the size and maximum size of a data space's dimensions.
int H5Sget_simple_extent_dims(hid_t spaceId, hsize_t dims[], hsize_t maxDims[] )
Parameters
Parameter |
Description |
Value Range |
Input/Output |
|---|---|---|---|
spaceId |
Identifier of the data space to query |
Non-empty |
Input |
dims[] |
Pointer to the array for storing the extents of each dimension |
Non-empty |
Output |
maxDims[] |
Pointer to the array for storing the maximum extents of each dimension |
Non-empty |
Output |
Return Value
- Success: number of dimensions in the data space
- Failure: negative value
Notes
dims[] and maxDims[] can be null pointers only if no data needs to be obtained.
Parent topic: Data Space APIs