> ## 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.

# FRDocument オブジェクトの Analyze メソッド

> ABBYY FineReader Engine API の FRDocument オブジェクトの Analyze メソッド — ドキュメント内のすべてのページのレイアウト解析を実行します。

このメソッドは、ドキュメント内のすべてのページに対してレイアウト解析を実行します。

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

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

```cpp theme={null}
HRESULT Analyze(
  IPageAnalysisParams*      AnalysisParams,
  IObjectsExtractionParams* ExtractionParams,
  IRecognizerParams*        RecognizerParams
);
```

### C\#

```csharp theme={null}
void Analyze(
  IPageAnalysisParams      AnalysisParams,
  IObjectsExtractionParams ExtractionParams,
  IRecognizerParams        RecognizerParams
);
```

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

```vb theme={null}
Sub Analyze( _
  [AnalysisParams As IPageAnalysisParams = Nothing], _
  [ExtractionParams As IObjectsExtractionParams = Nothing], _
  [RecognizerParams As IRecognizerParams = Nothing] _
)
```

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

AnalysisParams

\[in] ドキュメントの[レイアウト解析](/ja/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageanalysisparams)のパラメーターを格納する [PageAnalysisParams](/ja/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageanalysisparams) オブジェクトを参照します。このパラメーターには 0 を指定できます。この場合、ドキュメントはデフォルトのパラメーターで解析されます。なお、[プロファイル](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles)が読み込まれている場合は、そのプロファイルで設定されたパラメーターが使用されます。

ExtractionParams

\[in] オブジェクト抽出のパラメーターを格納する [ObjectsExtractionParams](/ja/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/objectsextractionparams) オブジェクトを参照します。このパラメーターには 0 を指定できます。この場合、オブジェクトはデフォルトのパラメーターで抽出されます。なお、[プロファイル](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles)が読み込まれている場合は、そのプロファイルで設定されたパラメーターが使用されます。

RecognizerParams

\[in] レイアウト解析に必要な認識パラメーター (たとえば認識言語) を格納する [RecognizerParams](/ja/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/recognizerparams) オブジェクトを参照します。このパラメーターには 0 を指定できます。この場合、デフォルトのパラメーターが使用されます。なお、[プロファイル](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles)が読み込まれている場合は、そのプロファイルで設定されたパラメーターが使用されます。

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

ユーザーがレイアウト解析を中断した場合、このメソッドは E\_ABORT を返します。また、[ABBYY FineReader Engine 関数の標準戻りコード](/ja/fine-reader/engine/api-reference/return-codes) を返すこともあります。

<div id="remarks">
  ## 備考
</div>

* このメソッドは、[FRDocument](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument) オブジェクトの IConnectionPointContainer インターフェイスに登録されているリスナーに対して、イベントを通知することがあります。
* Linux および Windows では、[IEngine::MultiProcessingParams](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/properties#multiprocessingparams) プロパティの値に応じて、ABBYY FineReader Engine は複数ページのドキュメントに対するレイアウト解析を CPU コアに分散して実行できます。

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

[FRDocument](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument)

[プロファイルの操作](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles)