CA_VariantGetBSTR
HRESULT CA_VariantGetBSTR (VARIANT *variant, BSTR *value);
Purpose
Copies the value in a variant into a BSTR variable.
On success, CA_VariantGetBSTR marks the variant as empty.
CA_VariantGetBSTR returns an error if the variant does not contain a BSTR value.
Use CA_FreeBSTR to free the returned BSTR.
Parameters
| Output | ||
| Name | Type | Description |
| variant | VARIANT | Pointer to a variant that contains a BSTR value. CA_VariantGetBSTR marks the variant as empty on success. |
| value | BSTR | BSTR value CA_VariantGetBSTR copies from the variant. Use CA_FreeBSTR to free the returned BSTR. |
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