TWAIN ActiveX/Plug-in Windows/Mac HTTP Control/SDK

SaveAsJPEG Method

Description

Saves the image of a specified index in buffer as a JPEG file.

Support information

ActiveX Edition	Plug-in Edition	Mac Edition
Since V2.0	Since V4.0	Since V6.4

Syntax

Boolean ObjectName. SaveAsJPEG(String FileName, Short sImageIndex)

Parameters

String FileName: the name of the JPEG file to be saved. It should be an absolute path on the local disk.

Short sImageIndex: specifies the index of image in buffer. The index is 0-based.

Return value

Boolean.

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

JPEG compression is a built-in feature of Dynamic Web TWAIN, no other DLLs are required.

JPEG standard defines that only 256 gray-scaled image and 24 bit RGB image can be compressed as JPEG format.

If you would like to save images by showing the browser dialog box, you can set IfShowFileDialog to true.

Samples

Save new acquired image as a JPEG file automatically after a transfer ends.

VB Sample:

Private Sub BeginScan()
    Twain.OpenSource
    Twain.IfShowUI = False    'Set without user interface
    Twain.IfDisableSourceAfterAcquire = True
    Twain.AcquireImage
End Sub

Private Sub Twain_OnPostTransfer()
    Twain.SaveAsJPEG "C:\SaveAsJPEG.jpg", 0
End Sub

JavaScript Sample:

<script language="javascript">
    function btnSaveJPEG_onclick() {
        WebTWAIN.SaveAsJPEG("C:/ImageData.jpg",0);
    }
</script>