VintaSoft Twain .NET SDK 15.4: Documentation for .NET developer
Vintasoft.EsclImageScanning Namespace / EsclDevice Class / AcquireImageSyncAsFileStream(EsclScanDocumentFormat) Method
Syntax Exceptions Example Requirements SeeAlso
In This Topic
AcquireImageSyncAsFileStream(EsclScanDocumentFormat) Method (EsclDevice)
In This Topic
Synchronously acquires one image as byte array from this eSCL device.
Syntax
'Declaration

Public Function AcquireImageSyncAsFileStream( _
ByVal scanDocumentFormat
The format of image file that should be returned by this eSCL device.
As EsclScanDocumentFormat _
) As Byte[]
public byte[] AcquireImageSyncAsFileStream(
EsclScanDocumentFormat scanDocumentFormat
)

Parameters

scanDocumentFormat
The format of image file that should be returned by this eSCL device.

Return Value

Byte array that contains data of scanned image.
Exceptions
ExceptionDescription
Thrown if device is not opened OR current scanning job is not found.
Example

This C#/VB.NET code shows how to synchronously acquire images as PDF stream from eSCL device.


''' <summary>
''' Synchronously acquire images as PDF stream from eSCL device.
''' </summary>
Public Sub SynchronouslyAcquireImagesAsPdfStreamFromEsclDevice()
    ' 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 imageIndex As Integer = 0
        Dim acquiredImageBytes As Byte() = Nothing
        Do
            Try
                ' acquire image as PDF stream from eSCL device
                acquiredImageBytes = device.AcquireImageSyncAsFileStream(Vintasoft.EsclImageScanning.EsclScanDocumentFormat.PDF)
                ' if image is received
                If acquiredImageBytes IsNot Nothing Then
                    imageIndex += 1
                    Dim filename As String = String.Format("scannedImage-{0}.pdf", imageIndex)
                    If System.IO.File.Exists(filename) Then
                        System.IO.File.Delete(filename)
                    End If

                    System.IO.File.WriteAllBytes(filename, acquiredImageBytes)

                    System.Console.WriteLine(String.Format("Acquired image is saved to a file '{0}'.", filename))
                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 acquiredImageBytes IsNot Nothing

        ' close eSCL device
        device.Close()

        ' close eSCL device manager
        deviceManager.Close()
    End Using

    System.Console.ReadLine()
End Sub


/// <summary>
/// Synchronously acquire images as PDF stream from eSCL device.
/// </summary>
public void SynchronouslyAcquireImagesAsPdfStreamFromEsclDevice()
{
    // 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();

        int imageIndex = 0;
        byte[] acquiredImageBytes = null;
        do
        {
            try
            {
                // acquire image as PDF stream from eSCL device
                acquiredImageBytes = device.AcquireImageSyncAsFileStream(Vintasoft.EsclImageScanning.EsclScanDocumentFormat.PDF);
                // if image is received
                if (acquiredImageBytes != null)
                {
                    imageIndex++;
                    string filename = string.Format("scannedImage-{0}.pdf", imageIndex);
                    if (System.IO.File.Exists(filename))
                        System.IO.File.Delete(filename);

                    System.IO.File.WriteAllBytes(filename, acquiredImageBytes);

                    System.Console.WriteLine(string.Format("Acquired image is saved to a file '{0}'.", filename));
                }
                // 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 (acquiredImageBytes != null);

        // close eSCL device
        device.Close();

        // close eSCL device manager
        deviceManager.Close();
    }

    System.Console.ReadLine();
}

Requirements

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

See Also