setCapabilitiesAsync Метод

В этом разделе

Отправляет асинхронный запрос для установки значений возможностей TWAIN устройства.

Синтаксис

Javascript (Использование)
Javascript (Спецификация)

var instance = new Vintasoft.Twain.WebTwainDeviceJS(deviceName, productFamily, manufacturer, driverVersion, twainVersion, deviceManager, is64Bit);

var value; // Type: any

// Parameters
var twainCapabilitiesInfo; // Type: object[]
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.setCapabilitiesAsync(twainCapabilitiesInfo, successFunc, errorFunc);

function setCapabilitiesAsync(
   twainCapabilitiesInfoМассив, содержащий информацию о возможностях, которые необходимо установить. Каждый элемент массива должен содержать 2 поля: поле "capabilityId" и поле "capabilityValue". Поле "capabilityId" должно содержать имя возможности TWAIN устройства (список доступных имен можно получить из перечисления WebDeviceCapabilityIdEnumJS). Поле "capabilityValue" должно содержать значение возможностей TWAIN устройства.
 : object[], 
   successFuncФункция, которая будет выполнена, если запрос будет выполнен успешно. Прототип функции: "successFunc(twainDevice, setCapResults)", где параметр "twainDevice" - экземпляр класса WebTwainDeviceJS, параметр "setCapResults" - массив с результатами операций, задающих значения возможностей TWAIN-устройства.
 : Function, 
   errorFuncФункция, которая будет выполнена в случае неудачного запроса. Прототип функции: "errorFunc(twainDevice, errorMessage)", где параметр "twainDevice" - это экземпляр класса WebTwainDeviceJS, параметр "errorMessage" - строка, описывающая ошибку.
 : Function
) : any;

Parameters

twainCapabilitiesInfo: Массив, содержащий информацию о возможностях, которые необходимо установить. Каждый элемент массива должен содержать 2 поля: поле "capabilityId" и поле "capabilityValue". Поле "capabilityId" должно содержать имя возможности TWAIN устройства (список доступных имен можно получить из перечисления WebDeviceCapabilityIdEnumJS). Поле "capabilityValue" должно содержать значение возможностей TWAIN устройства.
successFunc: Функция, которая будет выполнена, если запрос будет выполнен успешно. Прототип функции: "successFunc(twainDevice, setCapResults)", где параметр "twainDevice" - экземпляр класса WebTwainDeviceJS, параметр "setCapResults" - массив с результатами операций, задающих значения возможностей TWAIN-устройства.
errorFunc: Функция, которая будет выполнена в случае неудачного запроса. Прототип функции: "errorFunc(twainDevice, errorMessage)", где параметр "twainDevice" - это экземпляр класса WebTwainDeviceJS, параметр "errorMessage" - строка, описывающая ошибку.

Исключения

Исключение	Описание
	Выбрасывается, если аргументы имеют неверные типы ИЛИ устройство не открыто ИЛИ возникает ошибка при установке значения возможностей устройства.

Ремарки

Эта функция отправляет асинхронный запрос для установки значений возможностей TWAIN устройства. Если вы хотите использовать синхронный запрос вместо асинхронного запроса, используйте функцию WebTwainDeviceJS.setCapabilities.

Пример

JavaScript

// create information about capabilities, which should be set
var twainCapabilitiesInfo = [
    { "capabilityId": "IPixelType", "capabilityValue": 1 },
    { "capabilityId": "IXResolution", "capabilityValue": 200 },
    { "capabilityId": "IYResolution", "capabilityValue": 200 },
    { "capabilityId": "FeederEnabled", "capabilityValue": true },
    { "capabilityId": "DuplexEnabled", "capabilityValue": true }
];
// send an asynchronous request to set capabilities of TWAIN scanner
twainDevice.setCapabilitiesAsync(twainCapabilitiesInfo, __twainDevice_setCapabilitiesAsync_success, __twainDevice_setCapabilitiesAsync_error);

Совместимость с веб браузерами

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

Справочник

WebTwainDeviceJS Class
Члены типа WebTwainDeviceJS

Отправить отзыв