CA_ServerReleaseEventObjHandles
HRESULT CA_ServerReleaseEventObjHandles (CAServerObjHandle serverObjectHandle, const IID *eventInterfaceId, CAObjHandle eventObjectHandles[]);
Purpose
Releases the client event objects obtained by an earlier successful call to CA_ServerGetEventObjHandles.
 |
Note Sample usage of this function is generated as comments in the ActiveX event wrapper function prototypes section of the ActiveX server header file. |
This function must be called from the same thread that called CA_ServerGetEventObjHandles.
|
Note When you hold unreleased client event object handles, the LabWindows/CVI ActiveX Library might receive requests from client applications to register or unregister event objects. These requests might not be processed until the client event object handles have been released. Due to synchronization issues, you must refrain from calling any unnecessary functions between calls to CA_GetEventObjHandles and CA_ReleaseEventObjHandles. |
Parameters
| Input | ||
| Name | Type | Description |
| serverObjectHandle | CAServerObjHandle | The handle to an ActiveX object in your ActiveX server. |
| eventInterfaceId | const IID * | The outgoing event interface Id specified by the server object and implemented by client event objects. |
| Output | ||
| Name | Type | Description |
| eventObjectHandles | CAObjHandle [] | An array of client event object handles previously obtained by calling CA_ServerGetEventObjHandles. |
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 7.0 and later