VintaSoft Twain .NET SDK 15.0: Documentation for Web developer
Vintasoft.Twain Namespace / WebAcquiredImageCollectionJS type / removeAtAsync Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
In This Topic
    removeAtAsync Method
    In This Topic
    Sends an asynchronous request to remove image from image collection.
    Syntax
    var instance = new Vintasoft.Twain.WebAcquiredImageCollectionJS(twainDeviceManager);
    
    var value; // Type: Vintasoft.Twain.WebAcquiredImageJS
    
    // Parameters
    var index; // Type: number
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.removeAtAsync(index, successFunc, errorFunc);
    
    
    function removeAtAsync(
    index
    A zero-based index of image in image collection.
    : number,
    successFunc
    A function that will be executed if request is executed successfully. Function prototype: "successFunc(imageCollection, image)", where 'imageCollection' parameter is an instance of WebAcquiredImageCollectionJS class, 'image' parameter is removed instance of WebAcquiredImageJS class.
    : Function,
    errorFunc
    A function that will be executed if request is failed. Function prototype: "errorFunc(imageCollection, errorMessage)", where 'imageCollection' parameter is an instance of WebAcquiredImageJS class, 'errorMessage' parameter is string that describes error.
    : Function
    ) : WebAcquiredImageJS;

    Parameters

    index
    A zero-based index of image in image collection.
    successFunc
    A function that will be executed if request is executed successfully. Function prototype: "successFunc(imageCollection, image)", where 'imageCollection' parameter is an instance of WebAcquiredImageCollectionJS class, 'image' parameter is removed instance of WebAcquiredImageJS class.
    errorFunc
    A function that will be executed if request is failed. Function prototype: "errorFunc(imageCollection, errorMessage)", where 'imageCollection' parameter is an instance of WebAcquiredImageJS class, 'errorMessage' parameter is string that describes error.

    Return Value

    An instance of WebAcquiredImageJS class that was removed from image collection.
    Exceptions
    ExceptionDescription
    Thrown if argument has wrong type OR image is not removed from image collection.
    Remarks

    This function sends an asynchronous request to remove image from image collection. If you want to use synchronous request instead of asynchronous request, please use WebAcquiredImageCollectionJS.removeAt function.

    Browser Compatibility
    9
    See Also