CA_GetActiveObjectByClassId
HRESULT CA_GetActiveObjectByClassId (const GUID *classId, const char *serverMachineName, CAObjHandle *objectHandle);
Purpose
 |
Note This function has been superseded by CA_GetActiveObjectByClassIdEx. 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.
|
Obtains a handle to an active ActiveX server object based on the Class ID of the object.
Parameters
| Input | ||
| Name | Type | Description |
| classId | const GUID * | Class ID of the ActiveX server object; located in the server type library. |
| serverMachineName | const char * | Name or IP address of the computer on which you want to run the ActiveX server. serverMachineName can be either a UNC name ("\\server") or a DNS name ("home.server.com"). If you pass NULL for the serverMachineName, CA_GetActiveObjectByClassId looks for the active ActiveX server on the same computer as your program. |
| 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