PageSaveImage Method

public void SaveImage(
	string FileName,
	IMF_FORMAT Format,
	[OptionalAttribute] IMAGEINDEX IMAGEINDEX,
	[OptionalAttribute] bool Append
)

Public Sub SaveImage ( 
	FileName As String,
	Format As IMF_FORMAT,
	<OptionalAttribute> IMAGEINDEX As IMAGEINDEX,
	<OptionalAttribute> Append As Boolean
)

public:
void SaveImage(
	[InAttribute] String^ FileName, 
	[InAttribute] IMF_FORMAT Format, 
	[OptionalAttribute] [InAttribute] IMAGEINDEX IMAGEINDEX, 
	[OptionalAttribute] [InAttribute] bool Append
)

Parameters

FileName

Type: SystemString

Format

Type: Kofax.OmniPageCSDK.IproPlusIMF_FORMAT

IMAGEINDEX (Optional)

Type: Kofax.OmniPageCSDK.IproPlusIMAGEINDEX

Append (Optional)

Type: SystemBoolean

The FileName parameter is the fully qualified path to the image file. The Format parameter is the image format of the output. See the description of the Format property of the ImageFile object for the supported image formats.

If the optional Boolean Append parameter is True and the selected image format is a multi-page one, the image is appended at the end of the image file. If the image file does not exist, it is created automatically. If the image file does not support multi-page images, a trappable error occurs. If the Append parameter is unspecified or is False, a single page image is created and if a file already exists with the specified name, it is overwritten.

The ImageIndex is an optional IMAGEINDEX parameter that selects which variant of the page image is to be saved. Possible values are listed under the IMAGEINDEX Enumeration topic.

If the ImageIndex parameter is unspecified, the II_CURRENT image is saved.

Reference