OnWarning Method of the IProcessingEvents Interface
This method is implemented on the client-side. It is called by ABBYY FineReader Engine for the InjectTextLayer method of the Engine object. It delivers to the client tips and warnings which occurred during processing. It may also process any Windows messages to avoid an effect that the application "is not responding" during long operations.
Syntax
C++
HRESULT OnWarning(
int PageIndex,
BSTR Warning,
VARIANT_BOOL* Cancel
);
C#
void OnWarning( int PageIndex, string Warning, ref bool Cancel );
Visual Basic .NET
Sub OnWarning( _ PageIndex As Integer, _ Warning As String, _ ByRef Cancel As Boolean _ )
Parameters
- PageIndex
- [in] This parameter contains the index of the page to which the tip or warning refers. The message can refer not only to one page but to the entire document. In this case, the value of the parameter is -1.
- Warning
- [in] Contains the tip or warning.
- Cancel
- [in, out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the processing function that reports the tip returns E_ABORT.
Return values
[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side, and in this case the value of the Cancel parameter is not taken into account.
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
17.09.2024 15:14:41