CA_ServerGetObjHandleFromIface
HRESULT CA_ServerGetObjHandleFromIface (void *thisInterfacePtr, CAServerObjHandle *serverObjectHandle);
Purpose
Gets the handle of the ActiveX object whose interface pointer is passed in the first parameter.
Parameters
| Input | ||
| Name | Type | Description |
| thisInterfacePtr | void * | An interface pointer of your ActiveX object. |
| Output | ||
| Name | Type | Description |
| serverObjectHandle | CAServerObjHandle | The handle to the ActiveX object whose interface pointer was passed in the thisInterfacePtr parameter. |
Return Value
| Name | Type | Description | ||
| status | HRESULT | A value indicating whether an error occurred. Function failure is indicated by a negative error code. 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 the COM runtime and passed on to you by the 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.
The error codes defined in <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h are too numerous to display here. These error codes can be returned to your ActiveX clients. |
Additional Information
Library: ActiveX Library
Include file: cviauto.h
LabWindows/CVI compatibility: LabWindows/CVI 6.0 and later