CA_CStringToBSTR
HRESULT CA_CStringToBSTR (const char cString[], BSTR *BSTR);
Purpose
Converts a C-style string into a BSTR. A BSTR is a Basic-style string that stores both text and length information.
CA_CStringToBSTR does not free the C-style string.
Use CA_FreeBSTR to free the returned BSTR.
Parameters
| Input | ||
| Name | Type | Description |
| cString | const char [] | C-style string you want to convert to a BSTR. |
| Output | ||
| Name | Type | Description |
| BSTR | BSTR | Basic-style string that CA_CStringToBSTR creates from cString. 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
Example
Refer to userint\activex\richTextbox.cws for an example of using the CA_CStringToBSTR function.