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

このメソッドは、ユーザーが実装した入力ストリームから画像ファイルを開き、開いたファイルに対応するページをドキュメントに追加します。

Windows では、このメソッドは AddImageFileFromMemory メソッドと異なり、Engine オブジェクトが OutprocLoader オブジェクトを使用して作成されている場合に使用できます。

​

構文

​

C++

HRESULT AddImageFileFromStream(
  IReadStream*            Stream,
  IImagePasswordCallback* Callback,
  IPrepareImageMode*      PrepareMode,
  IIntsCollection*        PageIndices,
  BSTR                    FileName
);

​

C#

void AddImageFileFromStream(
  IReadStream             Stream,
  IImagePasswordCallback  Callback,
  IPrepareImageMode       PrepareMode,
  IIntsCollection         PageIndices,
  string                  FileName
);

​

Visual Basic .NET

Sub AddImageFileFromStream( _
  Stream As IReadStream, _
  Callback As IImagePasswordCallback, _
  [PrepareMode As IPrepareImageMode = Nothing], _
  [PageIndices As IIntsCollection = Nothing], _
  [FileName As String = "0"] _
)

​

パラメーター

Stream

[in] ドキュメントに追加する画像ファイルを含む、型 IReadStream のユーザー実装オブジェクトのインターフェイスを指します。

Callback

[in] PDF 形式の画像にアクセスする際に必要になる可能性があるパスワード要求を処理するために使用される、型 ImagePasswordCallback のユーザー実装オブジェクトのインターフェイスを指す変数です。このパラメーターは省略可能で、0 を指定できます。その場合、パスワードで保護されたファイルは処理できません。

PrepareMode

[in] オープン時に画像をどのように前処理するかを指定する PrepareImageMode オブジェクトを指します。このパラメーターは省略可能で、0 を指定できます。その場合は既定のパラメーターが使用されます。プロファイル が読み込まれている場合は、そのプロファイルで設定されたパラメーターが使用されます。

PageIndices

[in] ドキュメントに追加するページのインデックスを指定する IntsCollection オブジェクトを指すパラメーターです。重複したインデックスは指定できない点に注意してください。同じページを複数回追加するには、このメソッドを複数回呼び出してください。
このパラメーターは省略可能で、0 を指定できます。その場合、開いたファイル内のすべてのページがドキュメントに追加されます。

FileName

[in] 画像ファイルの名前を指定します。この情報は、ファイル形式が明示的に指定されていない場合にその判別に使用され、またエラーメッセージでも使用されます。このパラメーターは省略可能で、0 を指定できます。

Windows および Linux: Office 形式を開くには、拡張子を含むドキュメント名を渡します。

​

戻り値

このメソッド固有の戻り値はありません。ABBYY FineReader Engine 関数の標準の戻り値が返されます。

​

注記

• SVG 形式のファイルは、ストリームから開くことはできません。
• このメソッドで PDF Portfolio ファイルを開くと、その表紙は常に出力ファイルに含まれます。
• このメソッドは、FRDocument オブジェクトの IConnectionPointContainer インターフェイスに接続されているリスナーに対して、イベントを通知することがあります。
• Linux および Windows の場合:
  • ライセンスに Office Formats Opening モジュールが含まれている場合、このメソッドを使用してサポートされている形式のデジタル文書を開くこともできます。
  • IEngine::MultiProcessingParams プロパティの値によっては、ABBYY FineReader Engine は複数ページの文書を開く処理を CPU コアに分散できます。
• Linux の場合: Engine オブジェクト が別プロセス サーバーとして読み込まれていると、このメソッドは動作しません。
• Windows の場合: このメソッドでは、WIC 互換ファイルを開くことはできません。

​

関連項目

FRDocument