Dynamsoft Home|Product Home

RemoveImage Method

Description

Removes the image of a specified index in buffer.

Syntax

Boolean ObjectName.RemoveImage(Short sImageIndexToBeDeleted)

Parameters

Short sImageIndexToBeDeleted: specifies the index of the image to be deleted  in buffer. The index is 0-based. 

Return value

Boolean.

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

None.

See also

RemoveAllImages(), CurrentImageIndexInBuffer property, HowManyImagesInBuffer property, MaxImagesInBuffer property

Sample

The following sample shows how to remove the current image from buffer:.

VB Sample: 
Private Sub RemoveCurrentImage()
    
    Twain.RemoveImage(Twain.CurrentImageIndexInBuffer)
        
End Sub