CA_VariantGetObjHandle
HRESULT CA_VariantGetObjHandle (VARIANT *variant, CAObjHandle *value);
Purpose
Converts the LPDISPATCH value in a variant into a CAObjHandle.
On success, CA_VariantGetObjHandle marks the variant parameter as empty.
CA_VariantGetObjHandle returns an error if the variant does not contain an LDISPATCH value.
When you no longer need objHandle, call CA_DiscardObjHandle to free it.
 |
Note CAObjHandles created by this function do not support multithreading and use LOCALE_NEUTRAL. To use different values for multithreading support and locale you can use either of the following approaches:
|
Parameters
| Output | ||
| Name | Type | Description |
| variant | VARIANT | Pointer to a variant that contains an LPDISPATCH value. CA_VariantGetObjHandle marks the variant as empty on success. |
| value | CAObjHandle | Object handle that CA_VariantGetObjHandle converts from the LPDISPATCH value in the variant. When you no longer need the CAObjHandle, call CA_DiscardObjHandle to free it. |
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