AcquiredImages_GetImageAsBase64String Method

In This Topic

Description

Returns acquired image as Base64 string.

Syntax

Visual Basic
Public Function AcquiredImages_GetImageAsBase64String( _ ByVal index As Long, _ ByVal imageFileFormat As enumTwainImageEncoderType _ ) As String

Parameters

index

Zero-based index of image in acquired image collection. Valid values are from 0 to (AcquiredImages_Count-1).

imageFileFormat

Value	Description
TWAINIMAGEENCODERTYPE_BmpEncoder	Encoder of BMP files.
TWAINIMAGEENCODERTYPE_JpegEncoder	Encoder of JPEG files.
TWAINIMAGEENCODERTYPE_PdfEncoder	Encoder of PDF documents.
TWAINIMAGEENCODERTYPE_PngEncoder	Encoder of PNG files.
TWAINIMAGEENCODERTYPE_TiffEncoder	Encoder of TIFF files.

Return Type

Image as Base64 string.

Remarks

This method returns a Base64 string which can be used in browser for previewing image.

Parameters of JPEG encoder can be set using JpegEncoder_JpegQuality and JpegEncoder_JpegColorSpace properties.

Parameters of PDF encoder can be set using PdfEncoder_Compression, PdfEncoder_MultiPage, PdfEncoder_PdfACompatible, PdfEncoder_DocumentAuthor, PdfEncoder_DocumentCreationDate, PdfEncoder_DocumentCreator, PdfEncoder_DocumentKeywords, PdfEncoder_DocumentModificationDate, PdfEncoder_DocumentProducer, PdfEncoder_DocumentSubject, PdfEncoder_DocumentTitle, PngEncoder_CompressionLevel (for ZIP compression), JpegEncoder_JpegQuality (for JPEG compression) and JpegEncoder_JpegColorSpace (for JPEG compression) properties.

Parameters of PNG encoder can be set using PngEncoder_CompressionLevel property.

Parameters of TIFF encoder can be set using TiffEncoder_Compression, ImageTiffMultipage, PngEncoder_CompressionLevel (for ZIP compression), JpegEncoder_JpegQuality (for JPEG compression) and JpegEncoder_JpegColorSpace (for JPEG compression) properties.

Information about error that occurs during method execution can be get using the Error and ErrorString properties.