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

# Engine Object の RecognizeImageFile メソッド

> ABBYY FineReader Engine API における Engine Object の RecognizeImageFile メソッド — このメソッドは画像ファイルを開き、前処理、レイアウト解析、認識、ページおよびドキュメントの合成を実行し、結果を選択した出力形式でエクスポートします。

このメソッドは、指定された画像ファイルを開き、前処理、レイアウト解析、認識、ページおよびドキュメントの合成を実行したうえで、認識されたテキストを選択した出力形式でエクスポートします。RecognizeImageFile メソッドでは、複数ページの画像を処理し、認識結果を単一のファイルにエクスポートできます。

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

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

```cpp theme={null}
HRESULT RecognizeImageFile(
  BSTR                         ImageFileName,
  IPrepareImageMode            PrepareMode,
  IDocumentProcessingParams*   DocumentProcessingParams,
  FileExportFormatEnum         ExportFormat,
  IUnknown*                    ExportParams,
  IImagePasswordCallback*      PasswordCallback,
  BSTR                         OutputFileName
);
```

### C\#

```csharp theme={null}
void RecognizeImageFile(
  string                   ImageFileName,
  IPrepareImageMode         PrepareMode,
  IDocumentProcessingParams DocumentProcessingParams,
  FileExportFormatEnum     ExportFormat,
  object                   ExportParams,
  IImagePasswordCallback   PasswordCallback,
  string                   OutputFileName
);
```

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

```vb theme={null}
Sub RecognizeImageFile( _
  ImageFileName As String, _
  PrepareMode As IPrepareImageMode, _
  DocumentProcessingParams As IDocumentProcessingParams, _
  ExportFormat As IFileExportFormatEnum, _
  ExportParams As Object, _
  PasswordCallback As IImagePasswordCallback, _
  OutputFileName As String _
)
```

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

ImageFileName

\[in] 認識対象の画像ファイルへのフルパスを指定します。このファイルが ABBYY FineReader Engine の内部形式でない場合は、[PrepareImageMode](/ja/fine-reader/engine/api-reference/image-related-objects/prepareimagemode) プロパティの既定値を使用して準備されます。[profile](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles) が読み込まれている場合は、その プロファイル で設定されたパラメーターが使用されます。

PrepareMode

\[in] 内部形式への画像変換用パラメーターを格納する [PrepareImageMode](/ja/fine-reader/engine/api-reference/image-related-objects/prepareimagemode) オブジェクトを参照する変数です。このパラメーターには 0 を指定することもでき、その場合は画像準備モードの既定のパラメーターが使用されます。[profile](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles) が読み込まれている場合は、その プロファイル で設定されたパラメーターが使用されます。

DocumentProcessingParams

\[in] すべての処理パラメーターを格納する [DocumentProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/documentprocessingparams) オブジェクトを参照します。このパラメーターには 0 を指定することもできます。その場合、文書は既定のパラメーターを使用して処理されます (すべての処理パラメーターは既定値に設定され、認識言語は英語です) 。[profile](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles) が読み込まれている場合は、その プロファイル で設定されたパラメーターが使用されます。

ExportFormat

\[in] [FileExportFormatEnum](/ja/fine-reader/engine/api-reference/enumerations/fileexportformatenum) 型のこの変数は、認識されたテキストのエクスポート先となる出力ファイルの形式を指定します。

ExportParams

\[in] この入力パラメーターには、ファイル形式に対応する型のエクスポートパラメーターオブジェクトを渡します。たとえば、RTF ファイルを作成する場合は、[RTFExportParams](/ja/fine-reader/engine/api-reference/parameter-objects/export-parameters/rtfexportparams) オブジェクトを作成し、必要なパラメーターを設定して、exporterParams 入力パラメーターとしてこのメソッドに渡します。このパラメーターは省略可能で、0 を指定することもできます。その場合、エクスポートパラメーターには既定値が使用されます。[profile](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles) が読み込まれている場合は、その プロファイル で設定されたパラメーターが使用されます。

<Warning>
  Linux で、プロセス外で読み込まれた ABBYY FineReader Engine を使用している場合は、このパラメーターに NULL を渡す必要があります。
</Warning>

PasswordCallback

\[in] PDF 形式の画像へのアクセス時に発生する可能性があるパスワード要求を処理するために使用される、ユーザー実装オブジェクト (型 [ImagePasswordCallback](/ja/fine-reader/engine/api-reference/image-related-objects/iimagepasswordcallback)) のインターフェイスを参照します。このパラメーターは省略可能で、0 を指定することもできます。その場合、パスワード保護されたファイルは処理できません。

OutputFileName

\[in] 認識されたテキストのエクスポート先となる出力ファイルへのフルパスを指定します。この場所にファイルがすでに存在する場合は、確認なしで上書きされるか、エクスポートモードに応じて、その末尾に認識されたテキストが追加されます。

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

認識処理がユーザーによって中断された場合、このメソッドは E\_ABORT を返します。パターントレーニングがユーザーによって中断された場合、このメソッドは FREN\_E\_PATTERN\_TRAINING\_ABORTED を返します。また、[ABBYY FineReader Engine 関数の標準の戻りコード](/ja/fine-reader/engine/api-reference/return-codes)も返します。

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

Linux および Windows では、[IEngine::MultiProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/multiprocessingparams) プロパティの値に応じて、ABBYY FineReader Engine は複数ページの文書処理を CPU コアに分散できます。

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

[Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface)

[IImagePasswordCallback](/ja/fine-reader/engine/api-reference/image-related-objects/iimagepasswordcallback)

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