LabWindows/CVI

Content Type
Programming Language
Current manual
Table of Contents

CA_VariantSetBool

CA_VariantSetBool

HRESULT CA_VariantSetBool (VARIANT *variant, VBOOL value);

Purpose

Stores a VBOOL value in a variant and sets the type field of the variant accordingly.

Parameters

Input
Name Type Description
value VBOOL Value to store in variant.
Output
Name Type Description
variant VARIANT Variant to which CA_VariantSetBool assigns boolValue.

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

Was this information helpful?