Admin Production ni-theme
Current Publication

CA_EnableEventsForServerObject

LabWindows/CVI

CA_EnableEventsForServerObject

HRESULT CA_EnableEventsForServerObject (CAObjHandle serverObject, const IID *eventClassIID);

Purpose

Enables all registered callbacks in a particular event class for an ActiveX server object.

Call this function only when you pass 0 in the enableCallbacks parameter of CA_RegisterEventCallback for every callback that you register in the event class. This function has no effect if you call it for event callbacks that have already been enabled.

Parameters

Input
Name Type Description
serverObject CAObjHandle The CAObjHandle of the server object for which you want to enable your event callbacks.
eventClassIID const IID * The IID that identifies the event class of the event callbacks that you want to enable.

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