VintaSoft Twain .NET SDK v10.2
cancelTransfer Method
Vintasoft.Twain Namespace > WebTwainDeviceJS type : cancelTransfer Method
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
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 the cancel current transfer command to the device (transfer will not be canceled right after execution of this method).
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.cancelTransfer(successFunc, errorFunc);
function cancelTransfer( 
   successFunc : object,
   errorFunc : object
) : any;

Parameters

successFunc
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
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