メインコンテンツへスキップ
このメソッドはクライアント側で実装されます。ABBYY FineReader Engine は、Document Viewer で次のいずれかの方法によって開始されたページ解析処理を始める前に、このメソッドを呼び出します。
  • コンテキストメニューの Analyze Page Layout 項目が選択される
  • Ctrl+E ホットキーが押される
  • IDocumentViewer::Commands の DoCommand メソッドを使用して MI_AnalyzeLayout コマンドが呼び出される
このメソッドは、アクティブなページがこれから解析されることをクライアントに通知します。このメソッドを使用すると、この操作をキャンセルできます。

構文

C++

HRESULT OnAnalyzePages( VARIANT_BOOL* Cancel );

C#

void OnAnalyzePages( out bool Cancel );

Visual Basic .NET

Sub OnAnalyzePages(ByRef Cancel As Boolean)

パラメーター

Cancel [out] プロセスを終了する必要があることを示すには、この変数を TRUE に設定します。この場合、ページは解析されません。

戻り値

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

注記

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

関連項目

IDocumentViewerEvents