LabWindows/CVI

Table of Contents
  • LabWindows/CVI Fundamentals
  • Creating Applications
  • Distributing Applications
  • Library Reference
  • Programmer Reference
  • Hardware Information

CA_VariantSetSafeArray

HRESULT CA_VariantSetSafeArray (VARIANT *variant, unsigned int arrayType, LPSAFEARRAY value);

Purpose

Stores a safe array in a variant and sets the type field of the variant accordingly.

Note    The value stored in the variant parameter is a reference to the original value. Call CA_VariantClear to free the original value.

Parameters

Input
Name Type Description
arrayType unsigned int Type of the safe array.

arrayType can contain any of the fundamental data types for variants, safe arrays, and properties except CAVT_EMPTY, CAVT_NULL, CAVT_CSTRING, or CAVT_OBJHANDLE.
value LPSAFEARRAY Value to store in variant.
Output
Name Type Description
variant VARIANT Variant to which CA_VariantSetSafeArray assigns safeArray.

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

Log in to get a better experience