IsPdfPortfolio Method of the Engine Object

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

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

Syntax

C++

HRESULT IsPdfPortfolio(
  BSTR                    FileName,
  IImagePasswordCallback* Callback,
  VARIANT_BOOL*           Result
);

C#

bool IsPdfPortfolio(
  string                 FileName,
  IImagePasswordCallback Callback
);

Visual Basic .NET

Function IsPdfPortfolio( _
  FileName As String, _
  [Callback As IImagePasswordCallback = Nothing] _
) As Boolean

Parameters

FileName

[in] This variable contains the full path to the PDF file, for which you need to find out if it is a PDF Portfolio.

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.

See also

Engine

IImagePasswordCallback