VintaSoft Twain .NET SDK v10.2
getImageInfo Method
Vintasoft.Shared Namespace > WebImageSourceJS type : getImageInfo Method
Zero-based index of image in image source.
Optional parameter that represents the rendering settings of image.
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 for getting information about image.
Syntax
var instance = new Vintasoft.Shared.WebImageSourceJS();
var value; // Type: any

// Parameters
var index; // Type:  number
var renderingSettings; // Type:  object
var successFunc; // Type:  object
var errorFunc; // Type:  object

value = instance.getImageInfo(index, renderingSettings, successFunc, errorFunc);
function getImageInfo( 
   index : number,
   renderingSettings : object,
   successFunc : object,
   errorFunc : object
) : any;

Parameters

index
Zero-based index of image in image source.
renderingSettings
Optional parameter that represents the rendering settings of image.
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:
  • imageSize: An object that contain image width and height.
  • imageResolution: An object that contain image resolution.
  • pixelFormat: The image pixel format.
  • isVector: Indicates that the image has vector decoder.
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

WebImageSourceJS type