Admin Production ni-theme
Current Publication

CA_ServerUnlockActiveObject

LabWindows/CVI

CA_ServerUnlockActiveObject

HRESULT CA_ServerUnlockActiveObject (CAServerObjHandle serverObjectHandle);

Purpose

Unlocks the ActiveX object whose handle is passed in the first parameter.

Note that this function must be called only for those objects that have been previously locked by a call to CA_ServerLockActiveObject.

Call CA_ServerUnlockActiveObject when you need to make an ActiveX object, which was previously locked when it was made visible, invisible and need to unlock the object.

Parameters

Input
Name Type Description
serverObjectHandle CAServerObjHandle The handle to an ActiveX object in your ActiveX server.

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.

Note   You should not return the ActiveX Library error codes from your ActiveX server to your ActiveX clients, unless you document them in your server documentation. An acceptable compromise in this case is to return E_UNEXPECTED to the clients.

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