CheckScannerBase Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains most of the functionality for support of check scanner devices.
public abstract class CheckScannerBase : Microsoft.PointOfService.BasicServiceObjects.CheckScannerBasictype CheckScannerBase = class
inherit CheckScannerBasicPublic MustInherit Class CheckScannerBase
Inherits CheckScannerBasic- Inheritance
Constructors
| CheckScannerBase() |
Creates an instance of the CheckScannerBase class. |
Fields
| AutomaticContrast |
Indicates the device can automatically adjust the contrast of the image. (Inherited from CheckScanner) |
| CropAreaBottom |
Indicates that the y endpoint value of the scanned image is set to the value of the DocumentHeight property. (Inherited from CheckScanner) |
| CropAreaEntireImage |
Indicates the crop area is equal to the scanned image. (Inherited from CheckScanner) |
| CropAreaResetAll |
Indicates that the crop area definitions (as specified by the value of the MaxCropAreas property) have their x,y and width/height values reset to 0,0 and DocumentWidth and DocumentHeight, respectively. (Inherited from CheckScanner) |
| CropAreaRight |
Indicates that the x endpoint value of a scanned image are set to the value of the DocumentWidth property. (Inherited from CheckScanner) |
| ExtendedErrorCheck |
Indicates that a check was detected in the check scanner device. (Inherited from CheckScanner) |
| ExtendedErrorFirmwareBadFile |
Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon) |
| ExtendedErrorNoCheck |
Indicates that no check was detected in the check scanner device. (Inherited from CheckScanner) |
| ExtendedErrorNoRoom |
Indicates there is no room for the scanned image to be stored in memory. (Inherited from CheckScanner) |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| GetRawImageData |
Indicates the image data from the check scanner is in a native format that cannot be converted to a bitmap. (Inherited from CheckScanner) |
| StatisticChecksScannedCount | (Inherited from CheckScanner) |
| StatisticCommunicationErrorCount |
Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon) |
| StatisticDeviceCategory |
Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticHoursPoweredCount |
Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon) |
| StatisticInstallationDate |
Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon) |
| StatisticInterface |
Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon) |
| StatisticManufactureDate |
Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon) |
| StatisticManufacturerName |
Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon) |
| StatisticMechanicalRevision |
Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon) |
| StatisticModelName |
Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon) |
| StatisticSerialNumber |
Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon) |
| StatisticUnifiedPOSVersion |
Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon) |
| StatusPowerOff |
Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon) |
| StatusPowerOffline |
Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon) |
| StatusPowerOffOffline |
Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon) |
| StatusPowerOnline |
Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon) |
| StatusScanComplete |
Indicates that the check scan is complete. (Inherited from CheckScanner) |
| StatusUpdateFirmwareComplete |
Indicates the update firmware process has completed successfully. (Inherited from PosCommon) |
| StatusUpdateFirmwareCompleteDeviceNotRestored |
Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceNeedsFirmware |
Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceOk |
Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnknown |
Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnrecoverable |
Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon) |
| StatusUpdateFirmwareProgress |
Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon) |
| WaitForever |
Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon) |
Properties
| AutoDisable | (Inherited from CheckScannerBasic) |
| CapAutoContrast |
Gets the Boolean value that indicates whether the contrast can be adjusted automatically. |
| CapAutoGenerateFileId |
Indicates whether the check scanner device can automatically create a file name for the captured image file. |
| CapAutoGenerateImageTagData |
Indicates whether the check scanner device can automatically generate tag data used in reference to the image file for the captured image. |
| CapAutoSize |
Indicates whether the height and width of the scanned document will be automatically placed in the DocumentHeight and DocumentWidth properties when the image is captured. |
| CapColor |
Indicates whether the check scanner device supports image formats other than bi-tonal. |
| CapCompareFirmwareVersion | (Inherited from CheckScannerBasic) |
| CapConcurrentMicr |
Indicates whether a check’s MICR (Magnetic Ink Character Recognition) data can be captured during a check scanning cycle (single-pass scanning). |
| CapContrast |
Gets the Boolean value that indicates the ability of the device to lighten or darken the scanned image. |
| CapDefineCropArea |
Indicates whether the check scanner device supports a feature that allows cropping of areas of interest within the scan image area defined by the DocumentHeight and DocumentWidth properties. |
| CapImageFormat |
Indicates which image file formats are supported by the check scanner device. |
| CapImageTagData |
Indicates whether the check scanner device can set tag data, as defined by the ImageTagData property, to the image data file stored in the ImageData property. |
| CapMicrDevice |
Indicates whether the check scanner device supports a check MICR read function. |
| CapPowerReporting | (Inherited from CheckScannerBasic) |
| CapStatisticsReporting | (Inherited from CheckScannerBasic) |
| CapStoreImageFiles |
Indicates whether the check scanner device can store check images in its hardware memory by using the StoreImage(Int32) method. |
| CapUpdateFirmware | (Inherited from CheckScannerBasic) |
| CapUpdateStatistics | (Inherited from CheckScannerBasic) |
| CapValidationDevice |
Indicates that a check doesn’t have to be removed from the check scanner device prior to performing validation printing. |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from CheckScannerBasic) |
| Color |
Specifies the image scan mode for subsequent document scan operations. |
| CommonProperties | (Inherited from CheckScannerBasic) |
| Compatibility | (Inherited from PosDevice) |
| ConcurrentMicr |
Indicates whether the check scanner device can conduct a MICR read during a check-scanning cycle. |
| Contrast |
Gets or sets the contrast to adjust the darkness of the image. |
| CropAreaCount |
Holds the number of defined crop areas that may be applied to the captured image. |
| CropAreas | |
| DataCount | (Inherited from CheckScannerBasic) |
| DataEventEnabled | (Inherited from CheckScannerBasic) |
| DeviceDescription | (Inherited from CheckScannerBasic) |
| DeviceEnabled |
Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from CheckScannerBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DocumentHeight |
Holds the height of the document scanned, or the height of the document to be scanned. |
| DocumentWidth |
Holds the width of the document scanned, or the width of the document to be scanned. |
| ErrorCount | (Inherited from CheckScannerBasic) |
| ExternallyClaimed | (Inherited from CheckScannerBasic) |
| FileId |
Holds the file name associated with the image data file. |
| FileIndex |
Holds the file location associated with the image data file when either the StoreImage(Int32) or RetrieveMemory(CheckImageLocate) methods are called. Its value is set prior to a DataEvent event being delivered to the application. |
| FreezeEvents | (Inherited from CheckScannerBasic) |
| HardwareId | (Inherited from PosCommon) |
| ImageData |
Holds the image data after the RetrieveImage(Int32) or RetrieveMemory(CheckImageLocate) methods are called. |
| ImageFormat |
Holds the data format of the image file that the device will use when it captures an image. |
| ImageMemoryStatus |
Indicates the current memory availability status if the device has the ability to store multiple image files. |
| ImageTagData |
Holds a string that specifies the tag name for the captured image data. The string may be specified by the application or automatically generated by the check scanner device. |
| IsExclusiveUseDevice |
Gets the Boolean value that indicates whether the Check Scanner is an exclusive-use device. (Inherited from CheckScanner) |
| MapMode |
Holds the mapping mode of the printer the application wants to use. |
| MaxCropAreas |
Specifies the maximum number of crop areas the device can support. |
| PowerNotify | (Inherited from CheckScannerBasic) |
| PowerState | (Inherited from CheckScannerBasic) |
| Properties |
Holds an instance of the CheckScannerProperties helper class, which contains getters and setters for CheckScanner properties. |
| Quality |
Sets the resolution of the device when a scan image is to take place. The resolution value is defined as dpi (dots per inch). |
| QualityList |
Defines the resolutions the check scanner device is capable of supporting. |
| RemainingImagesEstimate |
Provides a “best guess” estimate of the remaining number of images that can be stored. |
| ServiceObjectDescription | (Inherited from CheckScannerBasic) |
| ServiceObjectVersion | (Inherited from CheckScannerBasic) |
| State | (Inherited from CheckScannerBasic) |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
Methods
| BeginInsertion(Int32) |
Initiates the document insertion process. |
| BeginInsertionImpl(Int32) |
BeginInsertionImpl must be implemented by the service object to place the check scanner in check insertion processing. |
| BeginRemoval(Int32) |
Initiates the document removal process. |
| BeginRemovalImpl(Int32) |
BeginRemovalImpl must be implemented by the service object to initiate document removal processing. |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | (Inherited from CheckScannerBasic) |
| ClearImage(CheckImageClear) |
Clears a specific image or all the images in the device memory. |
| ClearImageImpl(CheckImageClear) |
The service object should override the default ClearImage(CheckImageClear) implementation only if the check scanner device supports storage of images. |
| ClearInput() | (Inherited from CheckScannerBasic) |
| ClearInputImpl() | (Inherited from CheckScannerBasic) |
| ClearInputProperties() |
Resets the values of properties altered by DataEvent or ErrorEvent. |
| Close() | (Inherited from CheckScannerBasic) |
| CompareFirmwareVersion(String) |
Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon) |
| CreateStatistic(String, Boolean, String) | (Inherited from CheckScannerBasic) |
| CreateStatistic(String, Boolean) | (Inherited from CheckScannerBasic) |
| DefineCropArea(Int32, Int32, Int32, Int32, Int32) |
Establishes one or more cropping areas that can be applied to a scanned image. |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DirectIO(Int32, Int32, Object) |
Used to communicate directly with the Service Object. (Inherited from PosCommon) |
| Dispose() | (Inherited from CheckScannerBasic) |
| Dispose(Boolean) | |
| EndInsertion() |
Ends the document insertion process. |
| EndInsertionImpl() |
EndInsertionImpl must be implemented by the service object to terminate the check insertion process. |
| EndRemoval() |
Ends the document removal or ejection mode. |
| EndRemovalImpl() |
EndRemovalImpl must be implemented by the service object to terminate the document removal process. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from CheckScannerBasic) |
| IncrementStatistic(String, Int32) | (Inherited from CheckScannerBasic) |
| IncrementStatistic(String) | (Inherited from CheckScannerBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for subsequent input/output processing. |
| PreFireEvent(DataEventArgs) |
Called prior to the delivery of a DataEvent event to the application. |
| PreFireEvent(DeviceErrorEventArgs) | (Inherited from CheckScannerBasic) |
| PreFireEvent(DirectIOEventArgs) | (Inherited from CheckScannerBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEvent(DataEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from CheckScannerBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from CheckScannerBasic) |
| Release() | (Inherited from CheckScannerBasic) |
| ResetStatistic(String) | (Inherited from CheckScannerBasic) |
| ResetStatistics() | (Inherited from CheckScannerBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from CheckScannerBasic) |
| ResetStatistics(String[]) | (Inherited from CheckScannerBasic) |
| RetrieveImage(Int32) |
Retrieves the most recently scanned image, which is resident in the working area memory, and to use it to populate the ImageData property. |
| RetrieveMemory(CheckImageLocate) |
Retrieves an image that was previously stored in memory and use it to set the ImageData property. |
| RetrieveMemoryImpl(CheckImageLocate) |
The service object should override the default implementation only if the check scanner device supports storage of images. |
| RetrieveStatistic(String) | (Inherited from CheckScannerBasic) |
| RetrieveStatistics() | (Inherited from CheckScannerBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from CheckScannerBasic) |
| RetrieveStatistics(String[]) | (Inherited from CheckScannerBasic) |
| ScanCheck() |
Returns a scanned image of the check, created from the raw data in the format specified by the value of the ImageFormat property. |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | (Inherited from CheckScannerBasic) |
| SetStatisticValue(String, Object) | (Inherited from CheckScannerBasic) |
| StoreImage(Int32) |
Stores an image or a cropped area of the image in the memory of the device. |
| StoreImageImpl(Bitmap) |
The service object should override the default implementation only if the check scanner device supports the storage of images. |
| UpdateFirmware(String) |
Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon) |
| UpdateStatistic(String, Object) | (Inherited from CheckScannerBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from CheckScannerBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from CheckScannerBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from CheckScannerBasic) |
Events
| DataEvent | (Inherited from CheckScannerBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from CheckScannerBasic) |
| ErrorEvent | (Inherited from CheckScannerBasic) |
| StateChangedEvent | (Inherited from CheckScannerBasic) |
| StatusUpdateEvent | (Inherited from CheckScannerBasic) |