Share via

CheckScanner.RetrieveImage Method

  • Article

2/27/2008

Retrieves the most recently scanned image that resides in the available memory and uses it to populate the ImageData property.

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

Syntax

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

public abstract void RetrieveImage (
    int cropAreaId
)

public:
virtual void RetrieveImage (
    int cropAreaId
) abstract

public abstract void RetrieveImage (
    int cropAreaId
)

public abstract function RetrieveImage (
    cropAreaId : int
)

Parameters

  • cropAreaId
    Specifies the numeric identifier for the storage location of the crop area definition to be applied to the most recently scanned image held in the working area memory of the device. If cropAreaID is set to CropAreaEntireImage, the area of the most recently scanned image is retrieved.

Remarks

If RetrieveImage is successful, it queues a DataEvent event. If an error occurs, RetrieveImage queues an ErrorEvent event.

If the CapImageTagData property is set to true, the ImageTagData property is set to the tag data associated with the image data file.

If a file name has been created for the image data by the Check Scanner device, then the FileId property is set to the file name. If no file name is available, FileId is set to null.

Many models of check scanner devices do not require any check handling processing from the application. Such devices may always be able to receive a check, scan the image into their available memory area, and require no commands to read and eject the check. For these types of Check Scanner devices, the BeginInsertion, EndInsertion, BeginRemoval, and EndRemoval methods return, and the service object raises the DataEvent event when the application sets the DataEventEnabled property to true. However, applications should still use these methods to make sure the application works across different check scanner devices.

RetrieveImage cannot be called after the RetrieveMemory method has been called, until a new document has been scanned.

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

Value

Meaning

Illegal

One of the following is the case:

  • There is no scanned image available in the available memory buffer to be retrieved.

  • The image has not yet been scanned.

  • The cropped area specified by CropAreaId is invalid.

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
CapImageTagData
FileId
ImageData
CheckScanner.BeginInsertion Method
CheckScanner.BeginRemoval Method
CheckScanner.EndInsertion Method
CheckScanner.EndRemoval Method