VintaSoft Twain .NET SDK v10.2
getImageInfo Method
Vintasoft.Shared Namespace > WebImageJS type : getImageInfo 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 for getting information about image.
Syntax
var instance = new Vintasoft.Shared.WebImageJS(imageSource, pageIndex);
var value; // Type: object

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

value = instance.getImageInfo(successFunc, errorFunc);
function getImageInfo( 
   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:
  • imageSize: An object that contains image width and height.
  • imageResolution: An object that contains image resolution.
  • pixelFormat: The image pixel format.
  • isVector: Indicates that the image has vector decoder.
  • image: An instance of Shared.WebImageJS class that represents the source 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.

Return Value

Request object.
Browser Compatibility
9
5
11
5
See Also

Reference

WebImageJS type