VintaSoft Twain .NET SDK v10.3
Vintasoft.Twain Namespace / WebTwainDeviceJS type / getCapability Method
Integer value of device capability identifier OR WebDeviceCapabilityIdEnumJS object.
WebTwainDeviceCapabilityUsageModeEnumJS for TWAIN device capability value.
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage (string): Error message.
    • blocked (boolean): Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
In This Topic
    getCapability Method
    In This Topic
    Sends an asynchronous request to a server for getting information about TWAIN device capability.
    Syntax
    var instance = new Vintasoft.Twain.WebTwainDeviceJS(deviceName,
                                                       productFamily,
                                                       manufacturer,
                                                       driverVersion,
                                                       twainVersion,
                                                       deviceManager);
    var value; // Type: any
    
    // Parameters
    var twainCapabilityId; // Type:  object
    var usageMode; // Type:  object
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    
    value = instance.getCapability(twainCapabilityId, usageMode, successFunc, errorFunc);
    function getCapability( 
       twainCapabilityId : object,
       usageMode : object,
       successFunc : object,
       errorFunc : object
    ) : any;

    Parameters

    twainCapabilityId
    Integer value of device capability identifier OR WebDeviceCapabilityIdEnumJS object.
    usageMode
    WebTwainDeviceCapabilityUsageModeEnumJS for TWAIN device capability value.
    successFunc
    Function that will be executed if request is executed successfully.
    Here is function prototype "function __success(data)".
    The data parameter has the following properties:
    • capability (object): The value of TWAIN device capability.
      Twain device capability is object with the following properties:
      • id (number): The identifier of TWAIN device capability.
      • name (string): The name of TWAIN device capability.
      • value (object): The value (was obtained using the Get mode) of TWAIN device capability.
        Value of TWAIN device capability is object with the following properties:
        • containerType (object): Instance of WebTwainValueContainerTypeEnumJS class that represents the container type of TWAIN device capability value.
        • valueType (object): Instance of WebTwainValueTypeEnumJS class that represents the type of TWAIN device capability value.
        • value (object): The current value of TWAIN device capability value.
        • defaultValue (object): The default value of TWAIN device capability value.
        • minValue (number): The minimum value of TWAIN device capability value.
        • maxValue (number): The maximum value of TWAIN device capability value.
        • stepSize (number): The step size of TWAIN device capability value.
        • supportedValues (object): The supported values of TWAIN device capability value.
      • currentValue (object): The curent value (was obtained using the GetCurrent mode) of TWAIN device capability.
      • defaultValue (object): The default value (was obtained using the GetDefault mode) of TWAIN device capability.
    errorFunc
    Function that will be executed if request is failed.
    Here is function prototype "function __error(data)".
    The data parameter can be:
    1. An object with following properties:
      • errorMessage (string): Error message.
      • blocked (boolean): Indicates that the requested action is blocked by another request.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    Exceptions
    ExceptionDescription
    Thrown if arguments have wrong types.
    Thrown if device is not opened.
    Example
    // This code shows how to get information about current value of PixelType capability of opened TWAIN device.
    
    // Information about device capability is received successfully.
    function __success(data) {
        var capability = data.capability;
        // write information about current capability value
        console.log("PixelType capability value :" + capability.currentValue);
    }
    
    // Information about device capability is NOT received.
    function __error(data) {
        // show information about error
        alert(data.errorMessage);
    }
    
    // get information about current value of PixelType capability
    var usageMode = new Vintasoft.Twain.WebTwainDeviceCapabilityUsageModeEnumJS("GetCurrent");
    
    // get information about current value of PixelType capability of opened TWAIN device
    twainDevice.getCapability(new Vintasoft.Twain.WebDeviceCapabilityIdEnumJS("IPixelType"), usageMode, __success, __error);
    Browser Compatibility
    9
    5
    15
    5
    See Also