> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IDocumentViewerEvents Interface の OnAnalyzePages メソッド

> Windows 上の ABBYY FineReader Engine Visual Components における IDocumentViewerEvents Interface の OnAnalyzePages メソッドです。このメソッドはクライアント側で実装されます。

このメソッドはクライアント側で実装されます。ABBYY FineReader Engine は、[Document Viewer](/ja/fine-reader/engine/visual-components-reference/documentviewer) で次のいずれかの方法によって開始されたページ解析処理を始める前に、このメソッドを呼び出します。

* コンテキストメニューの Analyze Page Layout 項目が選択される
* Ctrl+E ホットキーが押される
* IDocumentViewer::Commands の [DoCommand](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/commands/docommand-method) メソッドを使用して [MI\_AnalyzeLayout](/ja/fine-reader/engine/visual-components-reference/documentviewer/document-viewer-commands#mi_analyzelayout) コマンドが呼び出される

このメソッドは、アクティブなページがこれから解析されることをクライアントに通知します。このメソッドを使用すると、この操作をキャンセルできます。

<div id="syntax">
  ## 構文
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT OnAnalyzePages( VARIANT_BOOL* Cancel );
```

### C\#

```csharp theme={null}
void OnAnalyzePages( out bool Cancel );
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Sub OnAnalyzePages(ByRef Cancel As Boolean)
```

<div id="parameters">
  ## パラメーター
</div>

Cancel

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

<div id="return-values">
  ## 戻り値
</div>

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

<div id="remarks">
  ## 注記
</div>

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

<div id="see-also">
  ## 関連項目
</div>

[IDocumentViewerEvents](/ja/fine-reader/engine/visual-components-reference/idocumentviewerevents)