Admin Production ni-theme
Current Publication

CA_VariantCopy

LabWindows/CVI

CA_VariantCopy

HRESULT CA_VariantCopy (const VARIANT *sourceVariant, VARIANT *destinationVariant);

Purpose

Copies the contents of one variant to another variant. CA_VariantCopy makes a deep copy of the source variant by duplicating any allocated data that it contains.

Parameters

Input
Name Type Description
sourceVariant const VARIANT * Pointer to the variant that contains the value to copy.
Output
Name Type Description
destinationVariant VARIANT Variant into which CA_VariantCopy copies the sourceVariant contents.

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