Admin Production ni-theme
Current Publication

CNVGetArrayDataDimensions

LabWindows/CVI

CNVGetArrayDataDimensions

int CNVGetArrayDataDimensions (CNVData data, size_t numberOfDimensions, size_t dimensions[]);

Purpose

Gets the dimensions of the array data.

Note that different programming environments may interpret multidimensional arrays in different formats. For example, two-dimensional arrays can be interpreted in row-major or column-major formats. This can affect the dimensions and data of multidimensional arrays communicated between different programming environments.

Parameters

Input
Name Type Description
data CNVData The handle that identifies the network variable data.
numberOfDimensions size_t The number of dimensions of the network variable array data.
Output
Name Type Description
dimensions size_t[] The dimensions of the network variable array data. You must pass an array whose length is equal or greater than the value of the numberOfDimensions parameter.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. One indicates that a next item was found, zero indicates that a next item was not found, and a negative number indicates that an error occurred.

You can call CNVGetErrorDescription to obtain a string that describes the error.

Additional Information

Library: Network Variable Library

Include file: cvinetv.h

LabWindows/CVI compatibility: LabWindows/CVI 8.1 and later

Example

Refer to networkvariable\3DSim\NV3DSim.cws for an example of using the CNVGetArrayDataDimensions function.