Deletes the images of specified indices in the array.

Namespace: Dynamsoft.DotNet.TWAIN
Assembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C#
public bool RemoveImages(
	IndexList aryIndex
)
Visual Basic
Public Function RemoveImages ( _
	aryIndex As IndexList _
) As Boolean

Parameters

aryIndex
Type: Dynamsoft.DotNet.TWAIN..::..IndexList
Specifies the indices of image in buffer. The index is 0-based. ShortArray: an array with objects of short type. Its length is variable.

Return Value

True indicates success. False indicates failure.

Remarks

If aryIndex contains any invalid index, error message will be written into the ErrorString property and no image will be saved. But if aryIndex contains repeated valid index, the repeated index will be filtered, only keep one index. After the selected image is deleted, the following images's indices will change accordingly. If the original CurrentImageIndexInBuffer >= HowManyImagesInBuffer, CurrentImageIndexInBuffer = HowManyImagesInBuffer; Also the image will be selected. If the original CurrentImageIndexInBuffer is less than HowManyImagesInBuffer, CurrentImageIndexInBuffer will not change; also the image with index of CurrentImageIndexInBuffer will be selected.

Exceptions

ExceptionCondition
Dynamsoft.DotNet.TWAIN..::..TwainException When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString.

See Also