IDocumentViewerEvents インターフェイスの OnReadPages メソッド

このメソッドはクライアント側で実装されます。Document Viewer から次のいずれかの方法で開始されたページ認識処理の開始前に、ABBYY FineReader Engine によって呼び出されます。

• コンテキストメニューで Read Page 項目が選択された場合
• Ctrl+R ホットキーが押された場合
• IDocumentViewer::Commands の DoCommand メソッドを使用して MI_Read コマンドが呼び出された場合

このメソッドは、選択されたページが認識されようとしていることをクライアントに通知します。このメソッドを使用すると、処理をキャンセルできます。

​

構文

​

C++

HRESULT OnReadPages( VARIANT_BOOL* Cancel );

​

C#

void OnReadPages( out bool Cancel );

​

Visual Basic .NET

Sub OnReadPages(ByRef Cancel As Boolean)

​

Parameters

Cancel

[out] プロセスを終了する必要があることを示すには、この変数を TRUE に設定します。この場合、認識は実行されません。

​

戻り値

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

​

注記

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

​

関連項目

IDocumentViewerEvents