English (English)
CreateMultipageImageWriter Method of the Engine Object
This method creates a MultipageImageWriter object that may be used for saving multiple images into a single multi-page image file, with extended parameters of image saving.
Syntax
C++
HRESULT CreateMultipageImageWriter(
BSTR FileName,
ImageFileFormatEnum FileFormat,
IUnknown* ExtendedParams,
IMultipageImageWriter** Result
);
C#
IMultipageImageWriter CreateMultipageImageWriter( string FileName, IImageFileFormatEnum FileFormat, object ExtendedParams );
Visual Basic .NET
Function CreateMultipageImageWriter( _ FileName As String, _ FileFormat As IImageFileFormatEnum, _ ExtendedParams As Object _ ) As IMultipageImageWriter
Parameters
- FileName
- [in] This parameter contains the full path to the multi-page image file where the images will be saved. For example, "C:\MyPic.tif". If a file with this name already exists, it will be overwritten without prompt.
- FileFormat
- [in] A variable of the ImageFileFormatEnum type that specifies the format of the output file. Not all formats defined by this enumeration are supported for writing.
- ExtendedParams
- [in] This variable refers to a JpegExtendedParams or TiffExtendedParams object that defines parameters for saving the image to JPEG or TIFF format, respectively. This parameter is optional and may be NULL.
- Result
- [out, retval] A pointer to IMultipageImageWriter* pointer variable that receives the interface pointer of the MultipageImageWriter output object. This object allows one to append images to the end of the multi-page image file.
Return values
This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.
Remarks
Note that not all formats available for writing are suitable for multi-page images. Therefore, you can create the MultipageImageWriter object for one-page formats, but can add no more than one page to the resulting file.
See also
17.09.2024 15:14:40