English (English)
AddImageFileFromStream Method of the FRDocument Object
This method opens an image file from the input stream implemented by the user, and adds the pages corresponding to the opened file to the document.
Syntax
HRESULT AddImageFileFromStream(
IReadStream* Stream,
IImagePasswordCallback* Callback,
IPrepareImageMode* PrepareMode,
IIntsCollection* PageIndices,
BSTR FileName
);
Parameters
- Stream
- [in] Refers to the interface of the user-implemented object of the type IReadStream which contains the image file to be added to the document.
- 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] Refers to the PrepareImageMode object which specifies how an image will be preprocessed during opening. This parameter is optional and may be 0, in which case either the default parameters are used, or, if a profile has been loaded, the parameters set by this profile are used.
- PageIndices
- [in] This parameter refers to the IntsCollection object which specifies the indices of the pages which have to be added to the 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.
- FileName
- [in] Specifies the name of the image file. This information is used to define the format of the file, if not explicitly specified, and in error messages. This parameter is optional and may be 0. For opening the office formats, pass the name of the document with its extension.
Return values
This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.
Remarks
- This method does not work if the Engine object is loaded as an out-of-process server.
- When opening a PDF Portfolio file using this method, its cover is always included in the output file.
- This method may report events to the listeners attached to the IConnectionPointContainer interface of the FRDocument object.
- 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.
See also
03.07.2024 8:50:25