Share via

CheckScanner.StoreImage Method

  • Article

2/27/2008

Stores an image or a cropped area of the image in the memory of the device.

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

Syntax

'Declaration
Public MustOverride Sub StoreImage ( _
    cropAreaId As Integer _
)

public abstract void StoreImage (
    int cropAreaId
)

public:
virtual void StoreImage (
    int cropAreaId
) abstract

public abstract void StoreImage (
    int cropAreaId
)

public abstract function StoreImage (
    cropAreaId : int
)

Parameters

  • cropAreaId
    Specifies the numeric identifier for the storage location of the crop area definition to be applied to the image data file that is currently in the buffer memory area of the check scanner device. If cropAreaID is set to CropAreaEntireImage then an exact image of the buffer memory is stored in the device memory (no cropping applied).

Remarks

The RemainingImagesEstimate property is adjusted to reflect the approximate number of additional images that may be stored in the device memory based on the file size history of stored images.

The ImageMemoryStatus property indicates whether the device memory is full and is adjusted because of StoreImage.

The FileId, FileIndex, and ImageTagData properties must all be updated to reflect their respective values associated with the image data file before StoreImage is called. A value for FileIndex is always available and is supplied by the service object. The FileId and ImageTagData properties are set to null if the service object does not support those properties.

StoreImage may cause a PosControlException to be thrown with the following ErrorCodes.

Value

Meaning

Illegal

Either the check scanner device does not support storing images, that is, the CapStoreImageFiles property is set to false, or the cropped area that is specified by cropAreaID is invalid.

Failure

There was an internal error while trying to store the data.

Extended

ErrorCodeExtended = ExtendedErrorNoRoom.

There is no room for the image in memory.

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
FileId
FileIndex
ImageMemoryStatus
CapStoreImageFiles
ImageTagData