int H5Tget_array_dims(
hid_t adtype_id,
hsize_t dims[],
int perm[] )
| [1] |
int H5Tget_array_dims(
hid_t adtype_id,
hsize_t dims[] )
| [2] |
H5Tget_array_dims is a macro that is mapped to either
H5Tget_array_dims1 or
H5Tget_array_dims2,
depending on the needs of the application.
Such macros are provided to facilitate application compatibility. For example:
H5Tget_array_dims macro
will be mapped to H5Tget_array_dims1 and
will use the H5Tget_array_dims1 syntax
(first signature above)
if an application is coded for HDF5 Release 1.6.x.
H5Tget_array_dims macro
mapped to H5Tget_array_dims2 and
will use the H5Tget_array_dims2 syntax
(second signature above)
if an application is coded for HDF5 Release 1.8.x.
Macro use and mappings are fully described in “API Compatibility Macros in HDF5”; we urge you to read that document closely.
When both the HDF5 Library and the application are built and
installed with no specific compatibility flags,
H5Tget_array_dims is mapped to the most recent version of
the function, currently
H5Tget_array_dims2.
If the library and/or application is compiled for Release 1.6
emulation, H5Tget_array_dims will be mapped to
H5Tget_array_dims1.
Function-specific flags are available to override these settings
on a function-by-function basis when the application is compiled.
Specific compile-time compatibility flags and the resulting mappings are as follows:
| Compatibility setting | H5Tget_array_dims mapping |
|---|---|
Global settings |
|
| No compatibility flag | H5Tget_array_dims2 |
| Enable deprecated symbols | H5Tget_array_dims2 |
| Disable deprecated symbols | H5Tget_array_dims2 |
| Emulate Release 1.6 interface | H5Tget_array_dims1 |
Function-level macros |
|
H5Tget_array_dims_vers = 2 |
H5Tget_array_dims2 |
H5Tget_array_dims_vers = 1 |
H5Tget_array_dims1 |
H5Tget_array_dims interface
and the only interface available prior to HDF5 Release 1.8.0.
This signature and the corresponding function are now deprecated
but will remain directly callable as
H5Tget_array_dims1.
Signature [2] above was introduced with HDF5 Release 1.8.0
and is the recommended and default interface.
It is directly callable as
H5Tget_array_dims2.
See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.
SUBROUTINE h5tarray_create_f(base_id, rank, dims, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: base_id ! Identifier of array base datatype
INTEGER, INTENT(IN) :: rank ! Rank of the array
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims
! Sizes of each array dimension
INTEGER(HID_T), INTENT(OUT) :: type_id ! Identifier of the array datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tarray_create_f
| Release | C |
| 1.8.0 | The function
H5Tget_array_dims renamed to
H5Tget_array_dims1
and deprecated in this release.
The macro H5Tget_array_dims
and the function H5Tget_array_dims2
introduced in this release. |