H5T_GET_ARRAY_DIMS

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Retrieves sizes of array dimensions

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">int H5Tget_array_dims( hid_t adtype_id, hsize_t dims[], int perm[] )</code></pre>

HTML
<pre><code class="language-c">int H5Tget_array_dims( hid_t adtype_id, hsize_t dims[] )</code></pre>

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-fortran

HTML

<pre><code class="language-fortran">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</code></pre>

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5T_GET_ARRAY_DIMS is a macro that is mapped to either H5T_GET_ARRAY_DIMS1 or H5T_GET_ARRAY_DIMS2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

The H5T_GET_ARRAY_DIMS macro will be mapped to H5T_GET_ARRAY_DIMS1 and will use the H5T_GET_ARRAY_DIMS1 syntax (first signature above) if an application is coded for HDF5 Release 1.6.x.
The H5T_GET_ARRAY_DIMS macro mapped to H5T_GET_ARRAY_DIMS2H5Tget_array_dims2 and will use the H5T_GET_ARRAY_DIMS2H5Tget_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, H5T_GET_ARRAY_DIMS is mapped to the most recent version of the function, currently H5T_GET_ARRAY_DIMS2 H5Tget_array_dims2. If the library and/or application is compiled for Release 1.6 emulation, H5T_GET_ARRAY_DIMS will be mapped to H5T_GET_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`

Interface history: Signature [1] above is the original H5T_GET_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 H5T_GET_ARRAY_DIMS1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable asH5T_GET_ARRAY_DIMS2H5Tget_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.

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	Change
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.

Page tree

Versions Compared

Old Version 8

New Version Current

Key

Signature:

Description:

History:

The HDF Group

Site

Resources

Connect