VintaSoft Twain .NET SDK 15.4: Руководство для .NET разработчика
Vintasoft.EsclImageScanning Namespace / EsclDevice Class / AcquireImageSync Methods / AcquireImageSync(EsclScanDocumentFormat) Method
Синтаксис Exceptions Ремарки Example Требования Смотрите также
В этом разделе
AcquireImageSync(EsclScanDocumentFormat) Метод (EsclDevice)
В этом разделе
Синхронно получает одно изображение в формате RAW с этого устройства eSCL.
Синтаксис
'Declaration

Public Overloads Function AcquireImageSync( _
ByVal scanDocumentFormat
Формат файла изображения, который следует использовать во время получения изображения.
As EsclScanDocumentFormat _
) As EsclAcquiredImage

Parameters

scanDocumentFormat
Формат файла изображения, который следует использовать во время получения изображения.

Return Value

Текущее состояние процесса получения изображения.
Исключения
ИсключениеОписание
Выбрасывается, если устройство не открыто ИЛИ текущее задание сканирования не найдено ИЛИ устройство не может вернуть изображение в необработанном формате.
Ремарки

Этот метод должен вызываться в цикле до тех пор, пока метод не вернет null, т. е. больше нет изображений для сканирования.

Если устройство eSCL поддерживает формат EsclScanDocumentFormat.OctetStream, этот метод выполнит следующие шаги:

  • получение данных изображения в формате EsclScanDocumentFormat.OctetStream
  • создание объекта EsclAcquiredImage из необработанных данных изображения

Если устройство eSCL не поддерживает формат EsclScanDocumentFormat.OctetStream, этот метод выполнит следующие шаги:
  • получение данных изображения в формате EsclScanDocumentFormat.JPEG - спецификация eSCL указывает, что любое устройство eSCL должно поддерживать JPEG формат
  • распаковка данных изображения из формата JPEG в необработанный формат
  • создание Объект EsclAcquiredImage из необработанных данных изображения

Пример

Вот C#/VB.NET код, который демонстрирует, как синхронно получить изображения с устройства eSCL.


''' <summary>
''' Synchronously acquire images from eSCL device.
''' </summary>
Public Sub SynchronouslyAcquireImagesFromEsclDevice()
    ' 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 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
                    imageIndex += 1
                    Dim filename As String = String.Format("scannedImage-{0}.png", imageIndex)
                    If System.IO.File.Exists(filename) Then
                        System.IO.File.Delete(filename)
                    End If

                    acquiredImage.Save(filename)

                    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 acquiredImage IsNot Nothing

        ' close eSCL device
        device.Close()

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

    System.Console.ReadLine()
End Sub


/// <summary>
/// Synchronously acquire images from eSCL device.
/// </summary>
public void SynchronouslyAcquireImagesFromEsclDevice()
{
    // 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;
        Vintasoft.EsclImageScanning.EsclAcquiredImage acquiredImage = null;
        do
        {
            try
            {
                // acquire image from eSCL device
                acquiredImage = device.AcquireImageSync();
                // if image is received
                if (acquiredImage != null)
                {
                    imageIndex++;
                    string filename = string.Format("scannedImage-{0}.png", imageIndex);
                    if (System.IO.File.Exists(filename))
                        System.IO.File.Delete(filename);

                    acquiredImage.Save(filename);

                    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 (acquiredImage != null);

        // close eSCL device
        device.Close();

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

    System.Console.ReadLine();
}

Требования

Целевые платформы: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5

Смотрите также