IProcessingEvents インターフェイスの OnWarning メソッド

このメソッドはクライアント側で実装されます。ABBYY FineReader Engine によって、Engine オブジェクトの InjectTextLayer メソッドから呼び出されます。処理中に発生したヒントや警告がクライアントに通知されます。また、長時間の処理中にアプリケーションが応答していないように見えるのを防ぐため、システムメッセージを処理することもできます。

​

構文

​

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 _
)

​

パラメーター

PageIndex

[in] このパラメーターには、ヒントまたは警告の対象となるページのインデックスが格納されます。メッセージは特定の 1 ページだけでなく、ドキュメント全体を対象とすることもできます。この場合、パラメーターの値は -1 です。

Warning

[in] ヒントまたは警告が格納されます。

Cancel

[in, out] この変数を TRUE に設定すると、処理を中止する必要があることを示せます。この場合、ヒントを通知する処理関数は E_ABORT を返します。

​

戻り値

[C++ のみ] このメソッドが S_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。この場合、Cancel パラメーターの値は考慮されません。

​

備考

このメソッドのクライアント実装では、メソッド内でスローされるすべての例外を確実にキャッチして処理し、例外がメソッドの外に伝播しないようにする必要があります。例外がメソッドの外に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。

​

関連項目

IProcessingEvents

IEngine::InjectTextLayer