CA_VariantGetDispatch
HRESULT CA_VariantGetDispatch (VARIANT *variant, LPDISPATCH *value);
Purpose
Copies the value in a variant into an LPDISPATCH variable. An LPDISPATCH value is a dispatch pointer for an ActiveX object interface.
On success, CA_VariantGetDispatch marks the variant parameter as empty.
CA_VariantGetDispatch returns an error if the variant does not contain an LPDISPATCH value.
Parameters
| Output | ||
| Name | Type | Description |
| variant | VARIANT | Pointer to a variant that contains an LPDISPATCH value. CA_VariantGetDispatch marks the variant as empty on success. |
| value | LPDISPATCH | LPDISPATCH value that CA_VariantGetDispatch copies from the variant. When you no longer need the LPDISPATCH, free it by calling its Release function, as shown in the following example: lpDispatch->lpVtbl->Release(lpDispatch); |
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