Admin Production ni-theme
Current Publication

CA_VariantGet1DArraySize

LabWindows/CVI

CA_VariantGet1DArraySize

HRESULT CA_VariantGet1DArraySize (const VARIANT *variant, size_t *numberOfElements);

Purpose

Obtains the number of elements in a 1D safe array in the variant you specify.

Parameters

Input
Name Type Description
variant const VARIANT * Pointer to a variant that contains a 1D safe array.
Output
Name Type Description
numberOfElements size_t Number of elements 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