VintaSoft Twain .NET SDK v10.2
acquireModal Method
Vintasoft.Twain Namespace > WebTwainDeviceJS type : acquireModal 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 synchronous acquisition of image from the TWAIN device.
Syntax
var instance = new Vintasoft.Twain.WebTwainDeviceJS(deviceName,
                                                   productFamily,
                                                   manufacturer,
                                                   driverVersion,
                                                   twainVersion,
                                                   deviceManager);
var value; // Type: any

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

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

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:
  • acquireModalState: The state of the modal acquisition process.
  • imageAcquiringProgressValue: The progress, in percents, of synchronous image acquisition process.
  • imageId: The identifier of acquired image.
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.
Browser Compatibility
9
5
11
5
See Also

Reference

WebTwainDeviceJS type