VintaSoft Twain .NET SDK 15.0: Documentation for Web developer
Vintasoft.Shared Namespace / WebImageCollectionJS type / getImageFilesInfos Methods / getImageFilesInfos(Vintasoft.Shared.WebFileInfoJS[],function,function,Vintasoft.Shared.WebServiceJS) Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
    getImageFilesInfos(Vintasoft.Shared.WebFileInfoJS[],function,function,Vintasoft.Shared.WebServiceJS) Method
    In This Topic
    Sends an asynchronous request to a server and gets information about images, which are stored in files on server.
    Syntax
    var instance = new Vintasoft.Shared.WebImageCollectionJS();
    
    var value; // Type: any
    
    // Parameters
    var fileIds; // Type: WebFileInfoJS[]
    var successFunc; // Type: function
    var errorFunc; // Type: function
    var service; // Type: WebServiceJS
    
    value = instance.getImageFilesInfos(fileIds, successFunc, errorFunc, service);
    
    
    function getImageFilesInfos(
    fileIds
    An array of instances of WebFileInfoJS class.
    : WebFileInfoJS[],
    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:
    • files (object): Array of informations about images in image files. Information is object with following properties:
      • imageInfos (object): Information about images in image file.
      • isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
    • images (object): An array of WebImageJS objects created using imageInfos property from all files.
    : Function,
    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 (string): Error message.
      • blocked (boolean): Indicates that the requested action is blocked by another request.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    : Function,
    service
    WebServiceJS which allows to manage an image collection.
    : WebServiceJS
    ) : any;

    Parameters

    fileIds
    An array of instances of WebFileInfoJS class.
    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:
    • files (object): Array of informations about images in image files. Information is object with following properties:
      • imageInfos (object): Information about images in image file.
      • isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
    • images (object): An array of WebImageJS objects created using imageInfos property from all files.
    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 (string): Error message.
      • blocked (boolean): Indicates that the requested action is blocked by another request.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    service
    WebServiceJS which allows to manage an image collection.
    Exceptions
    ExceptionDescription
    Thrown if arguments have wrong types.
    Browser Compatibility
    9
    See Also