Admin Production ni-theme
Current Publication

CA_SafeArrayGetNumDims

LabWindows/CVI

CA_SafeArrayGetNumDims

HRESULT CA_SafeArrayGetNumDims (LPSAFEARRAY safeArray, unsigned int *numberOfDimensions);

Purpose

Obtains the number of dimensions in a safe array.

Parameters

Input
Name Type Description
safeArray LPSAFEARRAY Safe array.
Output
Name Type Description
numberOfDimensions unsigned int Number of dimensions in the safe array.

Return Value

Name Type Description
status HRESULT A value indicating whether an error occurred. Negative error codes indicate function failure.

Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. The LabWindows/CVI ActiveX Library explicitly returns error codes. Other error codes in winerror.h are generated by ActiveX servers and passed on to you by the LabWindows/CVI ActiveX Library.

You can use CA_GetAutomationErrorString to get the description of an error code or CA_DisplayErrorInfo to display the description of the error code.

Additional Information

Library: ActiveX Library

Include file: cviauto.h

LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later