VintaSoft Twain .NET SDK 15.1: Documentation for .NET developer
Vintasoft.Sane Namespace / SaneAcquiredImage Class / Save Methods / Save(String) Method
Syntax Exceptions Remarks Example Requirements SeeAlso
In This Topic
    Save(String) Method (SaneAcquiredImage)
    In This Topic
    Saves this image to a file.
    Syntax
    'Declaration
    
    Public Overloads Sub Save( _
    ByVal filename
    Name of file, where image must be saved.
    As String _
    )
    public void Save(
    string filename
    )
    public: void Save(
    string* filename
    )
    public:
    void Save(
    string^ filename
    )

    Parameters

    filename
    Name of file, where image must be saved.
    Exceptions
    ExceptionDescription
    Thrown if filename 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 PDF document compatible with version 1.4 or earlier of PDF standard.

    Image will be saved as BMP file if path has a 'bmp' extension.
    Image will be saved as PNG file if path has a 'png' extension.
    Image will be saved as new TIFF file or added to existing TIFF file if path has a 'tif' or 'tiff' extension.
    Image will be saved into new PDF file or added to existing PDF file if path has a 'pdf' extension.
    Image will be saved as JPEG file for all other extensions.

    Example

    This C#/VB.NET code shows how to acquire image from SANE device and save image to a JPEG file.

    
    ''' <summary>
    ''' Acquires image from SANE device and saves image to a JPEG file.
    ''' </summary>
    Public Sub AcquireImageFromSaneDeviceAndSaveImageToJpegFile()
            ' create SANE device manager
            Using deviceManager As New Vintasoft.Sane.SaneLocalDeviceManager()
                    ' open SANE device manager
                    deviceManager.Open()
    
                    ' get count of SANE 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 SANE device
                    Dim device As Vintasoft.Sane.SaneLocalDevice = deviceManager.Devices(0)
    
                    ' open SANE device
                    device.Open()
    
                    Dim acquiredImage As Vintasoft.Sane.SaneAcquiredImage
                    Do
                            Try
                                    ' acquire image from SANE device
                                    acquiredImage = device.AcquireImageSync()
                                    ' if image is received
                                    If acquiredImage IsNot Nothing Then
                                            System.Console.WriteLine("Image is acquired.")
    
                                            ' create JPEG encoder settings
                                            Dim jpegEncoderSettings As New Vintasoft.Sane.ImageEncoders.SaneJpegEncoderSettings()
                                            ' specify quality for JPEG image
                                            jpegEncoderSettings.JpegQuality = 70
    
                                            ' process acquired image
                                            acquiredImage.Save("test.jpg", jpegEncoderSettings)
                                    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 device has more images to scan
                    Loop While device.HasMoreImagesToScan
    
                    ' close SANE device
                    device.Close()
    
                    ' close SANE device manager
                    deviceManager.Close()
            End Using
    
            System.Console.ReadLine()
    End Sub
    
    
    
    /// <summary>
    /// Acquires image from SANE device and saves image to a JPEG file.
    /// </summary>
    public void AcquireImageFromSaneDeviceAndSaveImageToJpegFile()
    {
        // create SANE device manager
        using (Vintasoft.Sane.SaneLocalDeviceManager deviceManager = new Vintasoft.Sane.SaneLocalDeviceManager())
        {
            // open SANE device manager
            deviceManager.Open();
    
            // get count of SANE devices
            int deviceCount = deviceManager.Devices.Count;
            if (deviceCount == 0)
            {
                System.Console.WriteLine("Devices are not found.");
                return;
            }
    
            // select the first SANE device
            Vintasoft.Sane.SaneLocalDevice device = deviceManager.Devices[0];
    
            // open SANE device
            device.Open();
    
            Vintasoft.Sane.SaneAcquiredImage acquiredImage;
            do
            {
                try
                {
                    // acquire image from SANE device
                    acquiredImage = device.AcquireImageSync();
                    // if image is received
                    if (acquiredImage != null)
                    {
                        System.Console.WriteLine("Image is acquired.");
    
                        // create JPEG encoder settings
                        Vintasoft.Sane.ImageEncoders.SaneJpegEncoderSettings jpegEncoderSettings =
                            new Vintasoft.Sane.ImageEncoders.SaneJpegEncoderSettings();
                        // specify quality for JPEG image
                        jpegEncoderSettings.JpegQuality = 70;
    
                        // process acquired image
                        acquiredImage.Save("test.jpg", jpegEncoderSettings);
                    }
                    // 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 device has more images to scan
            while (device.HasMoreImagesToScan);
    
            // close SANE device
            device.Close();
    
            // close SANE device manager
            deviceManager.Close();
        }
    
        System.Console.ReadLine();
    }
    
    

    Requirements

    Target Platforms: .NET 9; .NET 8; .NET 7; .NET 6

    See Also