IImageViewerEvents インターフェイスの OnProgress メソッド

このメソッドはクライアント側に実装されます。Image Viewer でアクティブ ページの解析または認識を行っている間、ABBYY FineReader Engine によって呼び出されます。この処理は、次のいずれかの方法で開始できます。

• Image Viewer の次のコマンドを使用する:
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

これらのコマンドの呼び出し方法については、Image Viewer Commands の一覧を参照してください。

• Image Viewer と同期している Zoom Viewer の次のコマンドを使用する:
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

これらのコマンドの呼び出し方法については、Zoom Viewer Commands の一覧を参照してください。

• Image Viewer と同期している Document Viewer のコマンドを使用する:
  • MI_Read
  • MI_AnalyzeLayout

これらのコマンドの呼び出し方法については、Document Viewer Commands の一覧を参照してください。

• FineReader Engine API を使用する

このメソッドは、処理のおおよその進行率をクライアントに通知します。実装では、進行状況インジケーターを表示できます。また、長時間の処理中にアプリケーションが応答していないように見えるのを防ぐために、システム メッセージを処理することもできます。これは、ユーザー インターフェイスを備えたアプリケーションで役立ちます。このメソッドを使用すると、処理をキャンセルすることもできます。

​

構文

​

C++

HRESULT OnProgress(
  int           Percentage,
  VARIANT_BOOL* Cancel
);

​

C#

void OnProgress(
  int      Percentage,
  out bool Cancel
);

​

Visual Basic .NET

Sub OnProgress( _
  Percentage As Integer, _
  ByRef Cancel As Boolean _
)

​

パラメーター

Percentage

[in] 現在の作業の進捗率を示します。値の範囲は 0 ～ 100 です。

Cancel

[out] プロセスを終了する必要があることを示すには、この変数を TRUE に設定します。この場合、解析または認識処理は中止されます。

​

戻り値

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

​

備考

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

​

関連項目

ImageViewer

IImageViewerEvents