CA_GetEventCallback
HRESULT CA_GetEventCallback (void *eventClassInterface, int methodTableIndex, void *callbackFunction, void *callbackData, CAObjHandle *serverObject);
Purpose
 |
Note Normally, you do not use CA_GetEventCallback. Instead, the functions that the ActiveX Controller Wizard generate use this function. |
Returns the callback that you registered for a particular event.
Parameters
| Input | ||
| Name | Type | Description |
| eventClassInterface | void * | The ActiveX event interface pointer for the event class. |
| methodTableIndex | int | The index of the event in the table of event methods. The order of the event methods in the table is specified in the ActiveX server's type library. |
| Output | ||
| Name | Type | Description |
| callbackFunction | void * | The callback function that you registered for the event. |
| callbackData | void * | The callback data that you registered for this event. |
| serverObject | CAObjHandle | The CAObjHandle that identifies the server object that is firing the event. |
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.5 and later