VintaSoft Twain .NET SDK v10.2
getDevices Method
Vintasoft.Twain Namespace > WebTwainDeviceManagerJS type : getDevices Method
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: Error message.
    • blocked: Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
Sends an asynchronous request to a server for getting information about TWAIN devices installed in the system.
Syntax
var instance = new Vintasoft.Twain.WebTwainDeviceManagerJS(service);
var value; // Type: object

// Parameters
var successFunc; // Type:  object
var errorFunc; // Type:  object

value = instance.getDevices(successFunc, errorFunc);
function getDevices( 
   successFunc : object,
   errorFunc : object
) : object;

Parameters

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:
  • devices: An array of Twain.WebTwainDeviceJS objects.
  • defaultDeviceIndex: A zero-based index of default device.
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: Error message.
    • blocked: Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.

Return Value

Array of Twain.WebTwainDeviceJS if that information is avaliable, otherwise - undefined.
Browser Compatibility
9
5
11
5
See Also

Reference

WebTwainDeviceManagerJS type