Share via

CheckScanner.RetrieveMemory Method

  • Article

2/27/2008

Retrieves an image that was stored in memory and uses it to set the ImageData property.

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

Syntax

'Declaration
Public MustOverride Sub RetrieveMemory ( _
    by As CheckImageLocate _
)

public abstract void RetrieveMemory (
    CheckImageLocate by
)

public:
virtual void RetrieveMemory (
    CheckImageLocate by
) abstract

public abstract void RetrieveMemory (
    CheckImageLocate by
)

public abstract function RetrieveMemory (
    by : CheckImageLocate
)

Parameters

  • by
    Indicates how the image file is to be located so that it can be retrieved from the device memory storage. Possible values are defined by the CheckImageLocate enumeration.

Remarks

If RetrieveMemory is successful, it queues a DataEvent event. If the scanned data was not put in the ImageData property, RetrieveMemory queues an ErrorEvent event.

The following table shows the valid values for the by parameter.

Value

Meaning

FileId

Locates the image file that uses the FileId property value..

FileIndex

Locates the image file that uses the FileIndex property value.

ImageTagData

Locates the image file that uses the ImageTagData property value.

The FileId, FileIndex, and ImageTagData properties are all updated to reflect their respective values associated with the image data file after RetrieveMemory is called. A value for FileIndex is always available. The FileId and ImageTagData properties is set to null if the image file does not have data to be retrieved for those properties.

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

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

Value

Meaning

Illegal

One of the following conditions has occurred:

  • The CapStoreImageFiles property is set to false. This indicates that the device does not support storage of image files.

  • A value has been specified for the by parameter that does not exist in the CheckImageLocate enumerator.

  • The image data file could not be located because of an invalid value that is stored in the FileId, FileIndex, or ImageTagData properties.

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
ImageTagData
CheckImageLocate Enumeration