VintaSoft Twain .NET SDK 15.2: Documentation for .NET developer
Vintasoft.EsclImageScanning Namespace / EsclAcquiredImage Class / Save Methods / Save(Stream,EsclImageEncoderSettings) Method
Syntax Exceptions Remarks Example Requirements SeeAlso
In This Topic
    Save(Stream,EsclImageEncoderSettings) Method (EsclAcquiredImage)
    In This Topic
    Saves this image to a specified stream in the specified format and with specified encoder settings.
    Syntax
    Exceptions
    ExceptionDescription
    Thrown if stream is null or encoderSettings is null.
    Remarks

    Image can be:
    - saved as image file (BMP, JPEG, PNG, TIFF)
    - added to multipage TIFF file
    - saved into new PDF or PDF/A document
    - added to existing PDF or PDF/A document

    Available compressions for images saved into TIFF file:
    - without compression
    - CCITT Group 4 Fax compression
    - LZW compression
    - ZIP compression
    - JPEG compression

    Available compressions for images saved into PDF document:
    - without compression
    - CCITT Group 4 Fax compression
    - LZW compression
    - ZIP compression
    - JPEG compression

    Image can be added to a PDF document compatible with version 1.4 or earlier of PDF standard.


    Image will be saved as BMP file if encoderSettings is not null and encoderSettings is an /// instance of type EsclBmpEncoderSettings.

    Image will be saved as JPEG file if encoderSettings is not null and encoderSettings is an instance of type EsclJpegEncoderSettings.

    Image will be saved as PDF file if encoderSettings is not null and encoderSettings is an instance of type EsclPdfEncoderSettings.

    Image will be saved as PNG file if encoderSettings is not null and encoderSettings is an instance of type EsclPngEncoderSettings.

    Image will be saved as TIFF file if encoderSettings is not null and encoderSettings is an instance of type EsclTiffEncoderSettings.

    Example

    This C#/VB.NET code shows how to acquire images from eSCL device and save images to a PDF file.

    
    ''' <summary>
    ''' Acquires images from eSCL device and saves images to a PDF file.
    ''' </summary>
    Public Sub AcquireImagesFromEsclDeviceAndSaveImagesToPdfFile()
        ' create eSCL device manager
        Using deviceManager As New Vintasoft.EsclImageScanning.EsclDeviceManager()
            ' open eSCL device manager
            deviceManager.Open()
    
            ' wait while the eSCL device manager searches for eSCL devices
            System.Threading.Thread.Sleep(deviceManager.DeviceSearchTimeout)
            ' get count of eSCL devices
            Dim deviceCount As Integer = deviceManager.Devices.Count
            If deviceCount = 0 Then
                System.Console.WriteLine("Devices are not found.")
                Return
            End If
    
            ' select the first eSCL device
            Dim device As Vintasoft.EsclImageScanning.EsclDevice = deviceManager.Devices(0)
    
            ' open eSCL device
            device.Open()
    
            Dim acquiredImage As Vintasoft.EsclImageScanning.EsclAcquiredImage = Nothing
            Do
                Try
                    ' acquire image from eSCL device
                    acquiredImage = device.AcquireImageSync()
                    ' if image is received
                    If acquiredImage IsNot Nothing Then
                        System.Console.WriteLine("Image is acquired.")
    
                        ' create TIFF encoder settings
                        Dim pdfEncoderSettings As New Vintasoft.EsclImageScanning.ImageEncoders.EsclPdfEncoderSettings()
                        ' specify that image must be added to a PDF file
                        pdfEncoderSettings.PdfMultiPage = True
                        ' specify image must be compressed with ZIP compression
                        pdfEncoderSettings.PdfImageCompression = Vintasoft.EsclImageScanning.ImageEncoders.EsclPdfImageCompression.ZIP
    
                        ' process acquired image
                        acquiredImage.Save("test.pdf", pdfEncoderSettings)
                    Else
                        ' if image is not received
                        System.Console.WriteLine("Scan is completed.")
                        Exit Try
                    End If
                Catch ex As System.Exception
                    System.Console.WriteLine(String.Format("Scan is failed: {0}", ex.Message))
                    Exit Try
                End Try
                ' while image is acquired
            Loop While acquiredImage IsNot Nothing
    
            ' close eSCL device
            device.Close()
    
            ' close eSCL device manager
            deviceManager.Close()
        End Using
    
        System.Console.ReadLine()
    End Sub
    
    
    
    /// <summary>
    /// Acquires images from eSCL device and saves images to a PDF file.
    /// </summary>
    public void AcquireImagesFromEsclDeviceAndSaveImagesToPdfFile()
    {
        // create eSCL device manager
        using (Vintasoft.EsclImageScanning.EsclDeviceManager deviceManager = new Vintasoft.EsclImageScanning.EsclDeviceManager())
        {
            // open eSCL device manager
            deviceManager.Open();
    
            // wait while the eSCL device manager searches for eSCL devices
            System.Threading.Thread.Sleep(deviceManager.DeviceSearchTimeout);
            // get count of eSCL devices
            int deviceCount = deviceManager.Devices.Count;
            if (deviceCount == 0)
            {
                System.Console.WriteLine("Devices are not found.");
                return;
            }
    
            // select the first eSCL device
            Vintasoft.EsclImageScanning.EsclDevice device = deviceManager.Devices[0];
    
            // open eSCL device
            device.Open();
    
            Vintasoft.EsclImageScanning.EsclAcquiredImage acquiredImage = null;
            do
            {
                try
                {
                    // acquire image from eSCL device
                    acquiredImage = device.AcquireImageSync();
                    // if image is received
                    if (acquiredImage != null)
                    {
                        System.Console.WriteLine("Image is acquired.");
    
                        // create TIFF encoder settings
                        Vintasoft.EsclImageScanning.ImageEncoders.EsclPdfEncoderSettings pdfEncoderSettings =
                            new Vintasoft.EsclImageScanning.ImageEncoders.EsclPdfEncoderSettings();
                        // specify that image must be added to a PDF file
                        pdfEncoderSettings.PdfMultiPage = true;
                        // specify image must be compressed with ZIP compression
                        pdfEncoderSettings.PdfImageCompression = Vintasoft.EsclImageScanning.ImageEncoders.EsclPdfImageCompression.ZIP;
    
                        // process acquired image
                        acquiredImage.Save("test.pdf", pdfEncoderSettings);
                    }
                    // if image is not received
                    else
                    {
                        System.Console.WriteLine("Scan is completed.");
                        break;
                    }
                }
                catch (System.Exception ex)
                {
                    System.Console.WriteLine(string.Format("Scan is failed: {0}", ex.Message));
                    break;
                }
            }
            // while image is acquired
            while (acquiredImage != null);
    
            // close eSCL device
            device.Close();
    
            // close eSCL device manager
            deviceManager.Close();
        }
    
        System.Console.ReadLine();
    }
    
    

    Requirements

    Target Platforms: .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5

    See Also