English (English)
AddImageFileWithPasswordCallback Method of the FRDocument Object
This method opens an image file using the IImagePasswordCallback interface 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
HRESULT AddImageFileWithPasswordCallback(
BSTR ImageFileName,
IImagePasswordCallback* Callback,
IPrepareImageMode* PrepareMode,
IIntsCollection* PageIndices
);
Parameters
- ImageFileName
- [in] This variable contains the full path to the image file to be opened.
- 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 images in PDF format. This parameter is optional and may be 0, in which case password-protected files cannot be processed.
- 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. 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.
- If your license includes the Office Formats Opening module, you may also use this method to open digital documents of supported formats.
- Depending on the value of the IEngine::MultiProcessingParams property, ABBYY FineReader Engine can distribute opening of multi-page documents to CPU cores.
- This method does not work if the Engine object is loaded as an out-of-process server.
See also
03.07.2024 8:50:25