wvh_dimensions

Returns the number of dimensions and the size of each dimension.

C Usage

long *wvh_dimensions(wvh, dims)
WVH wvh;
long dims[OPI_MAX_ARRAY_DIMS];

FORTRAN Usage

INTEGER*4 LF_WVH_DIMENSIONS(l_wvh, l_dims)
INTEGER*4 l_wvh
INTEGER*4 l_dims(L_OPI_MAX_ARRAY_DIMS);

64-bit UNIX FORTRAN Usage

INTEGER*8 LF_WVH_DIMENSIONS(l_wvh, l_dims)
INTEGER*8 l_wvh
INTEGER*8 l_dims(L_OPI_MAX_ARRAY_DIMS);

Input Parameters

wvhβ€” The Wave variable handle of the variable.

Output Parameters

dimsβ€”An array of the size of each dimension.

Returned Values

Returns the number of dimensions.

If wvh is not a valid Wave variable handle, the returned value is –1.

If 0 is returned, the variable is a scalar for all types except structures.

See Also

wvh_is_scalar