getCapability(number,Vintasoft.Twain.WebTwainDeviceCapabilityUsageModeEnumJS) Method

In This Topic

Returns information about TWAIN device capability.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: Vintasoft.Twain.WebTwainCapabilityInfoJS

// Parameters
var twainCapabilityId; // Type: number
var usageMode; // Type: WebTwainDeviceCapabilityUsageModeEnumJS

value = instance.getCapability(twainCapabilityId, usageMode);

function getCapability(
   twainCapabilityIdAn integer value, which defines identifier of device capability.
 : number, 
   usageModeAn instance of WebTwainDeviceCapabilityUsageModeEnumJS class.
 : WebTwainDeviceCapabilityUsageModeEnumJS
) : WebTwainCapabilityInfoJS;

Parameters

twainCapabilityId: An integer value, which defines identifier of device capability.
usageMode: An instance of WebTwainDeviceCapabilityUsageModeEnumJS class.

Return Value

An instance of WebTwainCapabilityInfoJS class.

Exceptions

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

Remarks

This function sends a synchronous request to get information about TWAIN device capability. If you want to use asynchronous request instead of synchronous request, please use WebTwainDeviceJS.getCapabilityAsync function.

Example

JavaScript

// Displays information about pixel type of scanned images for opened TWAIN device.
function displayPixelType(twainDevice) {
    try {
        // specify that we need to get information about IPixelType capability
        var pixelTypeCapId = 257;
        // specify that we need to get current value of TWAIN device capability
        var capUsageMode = new Vintasoft.Twain.WebTwainDeviceCapabilityUsageModeEnumJS("GetCurrent");
        // get information about current value of PixelType capability of opened TWAIN device
        var pixelTypeCapInfo = twainDevice.getCapability(pixelTypeCapId, capUsageMode);
        // write information about current capability value
        console.log("PixelType capability value :" + pixelTypeCapInfo.get_CurrentValue());
    }
    catch (ex) {
        alert(ex);
    }
}

Browser Compatibility

Reference

WebTwainDeviceJS Class
WebTwainDeviceJS Members

Send Feedback