CheckScanner.ClearImage Method
2/27/2008
Clears a specific image or all the images in the device memory.
Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)
Syntax
'Declaration
Public MustOverride Sub ClearImage ( _
by As CheckImageClear _
)
public abstract void ClearImage (
CheckImageClear by
)
public:
virtual void ClearImage (
CheckImageClear by
) abstract
public abstract void ClearImage (
CheckImageClear by
)
public abstract function ClearImage (
by : CheckImageClear
)
Parameters
- 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.
Remarks
The following table shows the valid values for the by parameter.
Value |
Meaning |
All |
All images in the device are cleared. |
Locate the file to be cleared by using the FileId property value. |
|
Locate the file to be cleared by using the FileIndex property value. |
|
Locate the file to be cleared by using the ImageTagData property value. |
ClearImage may cause a PosControlException to be thrown with the following ErrorCodes.
Value |
Meaning |
Illegal |
An invalid value has been specified for by. |
NoExist |
The image specified could not be found. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.
See Also
Reference
CheckScanner Class
CheckScanner Members
Microsoft.PointOfService Namespace
CapStoreImageFiles
FileId
FileIndex
ImageTagData