CA_VariantSetObjHandle
HRESULT CA_VariantSetObjHandle (VARIANT *variant, CAObjHandle value, unsigned int desiredVariantType);
Purpose
Converts the value parameter into an interface pointer and stores the interface pointer in the variant parameter.
desiredVariantType determines which field of the variant parameter is filled.
 |
Note Use CA_VariantClear to free the interface pointer stored in the variant. |
Parameters
| Input | ||
| Name | Type | Description |
| value | CAObjHandle | Value to convert into an interface pointer and store in the variant parameter. |
| desiredVariantType | unsigned int | The resulting type of the variant parameter. desiredVariantType determines which field of the variant parameter is filled. Valid values for this parameter are CAVT_DISPATCH and CAVT_UNKNOWN. When using CAVT_DISPATCH, the value parameter should represent a dispatch interface. |
| Output | ||
| Name | Type | Description |
| variant | VARIANT | Variant into which the converted interface pointer is stored. |
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 6.0 and later