CA_CloseActiveXServer
HRESULT CA_CloseActiveXServer (HINSTANCE serverHInstance);
Purpose
Closes your ActiveX server.
If your server is a DLL, call this function in DllMain, for the DLL_PROCESS_DETACH case. If your server is an EXE, call this function in WinMain. You must call this function before calling CloseCVIRTE.
If you are using the ActiveX Server Wizard, call the Uninit function that the wizard generates for your server, in place of this function.
Parameters
| Input | ||
| Name | Type | Description |
| serverHInstance | HINSTANCE | The HINSTANCE of your server. Note that the HINSTANCE is passed in as an argument to DllMain and WinMain. If your code uses main instead of WinMain as the module entry point, this value is not available. Therefore, EXE servers must use WinMain as their entry point. |
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