CheckScanner.ClearImage Method

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Usage

'Usage
Dim by As CheckImageClear
Dim checkScanner1 As CheckScanner
checkScanner1.ClearImage(by)

'Declaration
Public MustOverride Sub ClearImage( _
    ByVal by As CheckImageClear _
)

public abstract void ClearImage(
    CheckImageClear by
);

public: abstract Void ClearImage(
    CheckImageClear^ by
);

public abstract void ClearImage(
    CheckImageClear by
);

public abstract function ClearImage(
     by : CheckImageClear
) : Void;

by
Indicates how the image file is to be located so that it can be removed from the device storage. Possible values are defined by the CheckImageClear enumerator.

The application calls ClearImage to clear a specific image or all the images in the device memory.

Valid values for the by parameter are:

Value	Meaning
All	All images in the device are cleared.
FileId	Locate the file to be cleared using the FileId property value.
FileIndex	Locate the file to be cleared using the FileIndex property value.
ImageTagData	Locate the file to be cleared using the ImageTagData property value.

Before calling this method, the application must open, claim, and enable the device.

ClearImage returns void if successful, and it can throw the following exceptions:

Value	Meaning
Illegal	An invalid value has been specified for by.
NoExist	The image specified couldn’t be found.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000