setCapabilities Method

In This Topic

Sets values of TWAIN device capabilities.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: object[]

// Parameters
var twainCapabilitiesInfo; // Type: object[]

value = instance.setCapabilities(twainCapabilitiesInfo);

function setCapabilities(
   twainCapabilitiesInfoAn array that contains information about capabilities, which must be set. Each element of array must contain 2 fields: field "capabilityId" and field "capabilityValue". Field "capabilityId" must contain name of TWAIN device capability (list of available names can be get from WebDeviceCapabilityIdEnumJS enumeration). Field "capabilityValue" must contain value of TWAIN device capability.
 : object[]
) : object[];

Parameters

twainCapabilitiesInfo: An array that contains information about capabilities, which must be set. Each element of array must contain 2 fields: field "capabilityId" and field "capabilityValue". Field "capabilityId" must contain name of TWAIN device capability (list of available names can be get from WebDeviceCapabilityIdEnumJS enumeration). Field "capabilityValue" must contain value of TWAIN device capability.

Return Value

An array with results of operations, which set values of TWAIN device capabilities.

Exceptions

Exception	Description
	Thrown if arguments have wrong types OR device is not opened OR error occurs during setting value of device capability.

Remarks

This function sends a synchronous request to set values of TWAIN device capabilities. If you want to use asynchronous request instead of synchronous request, please use WebTwainDeviceJS.setCapabilitiesAsync function.

Example

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 }
];
// set capabilities of TWAIN scanner
var setCapResults = twainDevice.setCapabilities(twainCapabilitiesInfo);

Browser Compatibility

Reference

WebTwainDeviceJS Class
WebTwainDeviceJS Members

Send Feedback