CA_VariantGetCString
HRESULT CA_VariantGetCString (VARIANT *variant, char **value);
Purpose
Converts the BSTR string in the variant you specify into a dynamically allocated C-style string.
On success, CA_VariantGetCString releases the contents of the variant and marks it as empty.
CA_VariantGetCString returns an error if the variant does not contain a BSTR value.
When you no longer need the C-style string, call CA_FreeMemory to free it.
Parameters
| Output | ||
| Name | Type | Description |
| variant | VARIANT | Pointer to a variant that contains a BSTR value. CA_VariantGetCString marks the variant as empty on success. |
| value | char * | Dynamically allocated C-style string that CA_VariantGetCString converts from the BSTR in the variant. When you no longer need the C-style string, call CA_FreeMemory to free it. |
Return Value
| Name | Type | Description |
| status | HRESULT | A value indicating whether an error occurred. Negative error codes indicate function failure. If the function succeeds, it returns a positive value representing the number of bytes, excluding the ASCII NUL byte, that it copied into the buffer. 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
Example
Refer to userint\activex\WebBrowser.cws for an example of using the CA_VariantGetCString function.