IsPdfPortfolioFromStream Method of the Engine Object

IsPdfPortfolioFromStream method of the Engine Object in the ABBYY FineReader Engine API — This method checks whether an input PDF file added from a stream is a PDF Portfolio.

This method finds out if an input PDF file added from the stream is a PDF Portfolio. Each PDF Portfolio file may contain several files of various types (textual documents, presentations, drawings, etc.).

Syntax

C++

HRESULT IsPdfPortfolioFromStream(
  IReadStream*            Stream,
  IImagePasswordCallback* Callback,
  VARIANT_BOOL*           Result
);

C#

bool IsPdfPortfolioFromStream(
  IReadStream             Stream,
  IImagePasswordCallback  Callback
);

Visual Basic .NET

Function IsPdfPortfolioFromStream( _
  Stream As IReadStream, _
  [Callback As IImagePasswordCallback = Nothing] _
) As Boolean

Parameters

Stream

[in] Refers to the interface of the user-implemented object of the type IReadStream containing a PDF file to check if it is a PDF Portfolio or not.

Callback

[in] This variable refers to the interface of the user-implemented object of the type ImagePasswordCallback which is used to handle possible password requests for accessing PDF files. This parameter is optional and may be 0 in which case password-protected files cannot be checked.

Result

[out, retval] This parameter returns TRUE if a PDF file is a PDF Portfolio and FALSE if it is not.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

Remarks

In Linux, this method does not work if the Engine object is loaded as an out-of-process server.

See also

Engine

IImagePasswordCallback