> ## 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 オブジェクトの PrepareBitmapBits メソッド

> ABBYY FineReader Engine API の Engine オブジェクトにある PrepareBitmapBits メソッドです。このメソッドは、指定されたビットマップデータのコピーを FineReader Engine の内部画像形式で作成します（Windows のみ）。

<Warning>
  このメソッドは Linux または macOS では実装されていません。
</Warning>

このメソッドは、指定された[ビットマップデータ](/ja/fine-reader/engine/api-reference/enumerations/bitmapbitsformatenum)のコピーを [FineReader Engine の内部画像形式](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-images#internal_format) で作成します。サポートされる画像形式は次のとおりです。

* 1 ビット モノクロ (各ピクセルは 1 ビットで表されます) 。
* 8 ビット グレースケール (各ピクセルは 8 ビットで表されます) 。
* 24 ビット カラー (各ピクセルは 24 ビットで表され、R、G、B の各成分に 8 ビットずつ使用します) 。

このメソッドで取得した出力画像は、[IEngine::LoadImageDoc](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/processing-methods/loadimagedoc-method) メソッドを使用して開くことができます。

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

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

```cpp theme={null}
HRESULT PrepareBitmapBits(
  BitmapBitsFormatEnum Format,
  int                  Width,
  int                  Height,
  int                  ByteWidth,
  int                  XResolution,
  int                  YResolution,
  __int64              RawDataPtr,
  BSTR                 DestinationFolderName,
  IPrepareImageMode*   PrepareMode
);
```

### C\#

```csharp theme={null}
void PrepareBitmapBits(
  BitmapBitsFormatEnum Format,
  int                  Width,
  int                  Height,
  int                  ByteWidth,
  int                  XResolution,
  int                  YResolution,
  Int64                RawDataPtr,
  string               DestinationFolderName,
  IPrepareImageMode     PrepareMode
);
```

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

```vb theme={null}
Sub PrepareBitmapBits( _
  Format As BitmapBitsFormatEnum, _
  Width As Integer, _
  Height As Integer, _
  ByteWidth As Integer_
  XResolution As Integer, _
  YResolution As Integer, _
  RawDataPtr As Int64, _
  DestinationFolderName As String, _
  [PrepareMode As IPrepareImageMode = Nothing] _
)
```

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

Format

\[in] [BitmapBitsFormatEnum](/ja/fine-reader/engine/api-reference/enumerations/bitmapbitsformatenum) 型のこのパラメーターは、準備対象のビットマップ データの形式を指定します。

Width

\[in] ビットマップの幅をピクセル単位で指定します。このパラメーターに 0 は指定できません。

Height

\[in] ビットマップの高さをピクセル単位で指定します。このパラメーターに 0 は指定できません。

ByteWidth

\[in] ビットマップの 1 行分の幅をバイト単位で指定します。アラインメントを考慮する必要があります。このパラメーターに 0 は指定できません。

XResolution

\[in] ビットマップの水平方向の解像度を dpi で指定します。

YResolution

\[in] ビットマップの垂直方向の解像度を dpi で指定します。

RawDataPtr

\[in] このパラメーターは、ビットマップ データを含むメモリー バッファーへのハンドルとして扱われます。ハンドルは [\_\_int64](/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties) として渡されます。データ形式の詳細については、[BitmapBitsFormatEnum](/ja/fine-reader/engine/api-reference/enumerations/bitmapbitsformatenum) の各定数の説明を参照してください。

DestinationFolderName

\[in] 内部画像形式 の画像を保存するフォルダーのフル パスを指定します。このフォルダーは存在している必要があります。存在しない場合は、エラー コードが返されます。

PrepareMode

\[in] 画像の準備モードを定義する [PrepareImageMode](/ja/fine-reader/engine/api-reference/image-related-objects/prepareimagemode) object を参照します。0 を指定することもでき、その場合は PrepareImageMode のプロパティの既定値が使用されます。また、[プロファイル](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles) が読み込まれている場合は、そのプロファイルで設定されたパラメーターが使用されます。

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

Windows: このメソッド固有の戻り値はありません。代わりに、[ABBYY FineReader Engine 関数の標準戻り値](/ja/fine-reader/engine/api-reference/return-codes)を返します。

Linux および macOS: このメソッドは E\_NOTIMPL を返します。

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

* 準備済み画像を含むファイルが不要になった時点で削除する必要がある場合は、その処理をアプリケーションに実装してください。これらのファイルは、ABBYY FineReader Engine によってディスクから自動的に削除されません。
* Linux で Engine が別プロセスサーバーとして読み込まれている場合、または Windows で [OutprocLoader](/ja/fine-reader/engine/api-reference/engine-loaders/outprocloader) オブジェクトを使用してオブジェクトを作成している場合、このメソッドは機能しません。

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

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

[OpenBitmapBits](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/processing-methods/openbitmapbits-method)

[LoadImageDoc](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/processing-methods/loadimagedoc-method)

[BitmapBitsFormatEnum](/ja/fine-reader/engine/api-reference/enumerations/bitmapbitsformatenum)

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