Synopsis
INTEGER FUNCTION OMFget_array_dims(object_id,
. ndims,
. dims)
#include <avs/omf.inc>
INTEGER object_id(OIDSIZ)
INTEGER ndims
INTEGER dims(ndims)
Description
For a complete description of this function, see .
Arguments
object_id
The id of an object, expressed as an integer.
ndims
The number of dimensions in the array, expressed as an integer.
dims
An array of ndim integer values specifying the dimensions of the array. The constant OM_ARRAY_MAXDIM defined in the include file omf.inc secifies the maximum number of dimensions allowed by AVS/Express. In order to pass the NULL reference instead of a locally defined array, pass the constant FPNULL defined in the include file omf.inc .
Returned value
The status code (see ).
Example
#include <avs/omf.inc>
INTEGER array_id(OIDSIZ)
INTEGER ndims
INTEGER dims(OM_ARRAY_MAXDIM)
...
IF (OMFget_array_dims(array_id,
. ndims,
. dims) .NE. 1)
. PRINT*,'Error getting array dimensions of object array'