CA_CreateObjHandleFromIDispatch
HRESULT CA_CreateObjHandleFromIDispatch (LPDISPATCH dispatchPtr, int callAddRef, CAObjHandle *objectHandle);
Purpose
 |
Note This function has been superseded by CA_CreateObjHandleFromInterface. The new function takes additional parameters for interface id, support multithreading, locale, and reserved. Calling this function is equivalent to passing the following values for those parameters.
|
Creates a CAObjHandle value when you already have a Dispatch pointer to an ActiveX object.
Parameters
| Input | ||
| Name | Type | Description |
| dispatchPtr | LPDISPATCH | Dispatch pointer to an ActiveX server object. |
| callAddRef | int | Specify a nonzero value or select in the function panel to invoke the AddRef method of the object. Specify 0 or select in the function panel if you do not want to call the AddRef method of the object. |
| Output | ||
| Name | Type | Description |
| objectHandle | CAObjHandle | Handle to the requested ActiveX object. You can pass objHandle to other functions in this library to call methods of the ActiveX object or to get and set properties of the ActiveX object. When you no longer need objHandle, discard it by calling CA_DiscardObjHandle. |
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