OnLocked Method of the IDocumentViewerEvents Interface

This method is implemented on the client-side. It is called after Document Viewer has been locked or unlocked. Document Viewer can be locked automatically before the beginning of a long-term processing operation and unlocked after the end of it. The component also can be locked or unlocked via the IDocumentViewer::Locked property.

The method delivers to the client information on whether the component is locked or unlocked.

Syntax

C++

HRESULT OnLocked( VARIANT_BOOL Value );
    

C#

void OnLocked( bool Value );
    

Visual Basic .NET

Sub OnLocked(Value As Boolean)
    

Parameters

Value
[in] Specifies whether the component is locked or unlocked. If the parameter is TRUE, the component has been locked. If the parameter is FALSE, the component has been unlocked.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side.

Remarks

The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also

IDocumentViewerEvents

03.07.2024 8:50:43

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.