Skip to main content
This method opens a password-protected image file and adds the pages corresponding to the opened file to a document. This method may report events to the listeners attached to the IConnectionPointContainer interface of the FRDocument object.

​
Syntax

​
C++

HRESULT AddImageFileWithPassword(
  BSTR               ImageFileName, 
  BSTR               Password,  
  IPrepareImageMode* PrepareMode,
  IIntsCollection*   PageIndices 
);

​
C#

void AddImageFileWithPassword(
  string           ImageFileName, 
  string           Password,  
  IPrepareImageMode PrepareMode,
  IIntsCollection   PageIndices 
);

​
Visual Basic .NET

Sub AddImageFileWithPassword( _
  ImageFileName As String, _
  Password As String, _
  [PrepareMode As IPrepareImageMode = Nothing], _
  [PageIndices As IIntsCollection = Nothing] _
)

​
Parameters

ImageFileName [in] This variable contains the full path to the image file to be opened. Password [in] This variable contains a password for accessing images in PDF format. PrepareMode [in] This parameter refers to the PrepareImageMode object which specifies how an image will be preprocessed during opening. PageIndices [in] This parameter refers to the IntsCollection object which specifies the indices of the pages which have to be added to a document. Note that repeated indices are not allowed. To add the same page several times, please call this method several times.
This parameter is optional and may be 0, in which case all the pages of the opened file will be added to the document.

​
Return values

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

​
Remarks

  • When opening a PDF Portfolio file using this method, its cover is always included in the output file.
  • For Linux and Windows:

​
See also

FRDocument AddImageFileWithPasswordCallback AddImageFile Working with Images