Creates an array datatype object
Procedure:
H5T_ARRAY_CREATE2(base_type_id, rank, dims)
Signature:
hid_t H5Tarray_create2( hid_t base_type_id, unsigned rank, const hsize_t dims[/*rank*/] )
Parameters:
hid_t base_type_id | IN: Datatype identifier for the array base datatype |
unsigned rank | IN: Rank of the array |
const hsize_t dims[/*rank*/] | IN: Size of each array dimension |
Description:
H5T_ARRAY_CREATE2 creates a new array datatype object.
base_type_id
is the datatype of every element of the array, i.e., of the number at each position in the array.
rank
is the number of dimensions and the size of each dimension is specified in the array dims
. The value of rank
is currently limited to H5S_MAX_RANK
and must be greater than 0
(zero). All dimension sizes specified in dims
must be greater than 0
(zero).
Returns:
Returns a valid datatype identifier if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.8.0 | C function introduced in this release. |
--- Last Modified: May 03, 2019 | 03:04 PM