CheckScannerBasic 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.
public abstract class CheckScannerBasic : Microsoft.PointOfService.CheckScanner, IDisposabletype CheckScannerBasic = class
inherit CheckScanner
interface IDisposablePublic MustInherit Class CheckScannerBasic
Inherits CheckScanner
Implements IDisposable- Inheritance
- Derived
- Implements
Constructors
| CheckScannerBasic() |
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 | |
| CapAutoContrast |
Gets the Boolean value that indicates whether the contrast can be adjusted automatically. (Inherited from CheckScanner) |
| CapAutoGenerateFileId |
Gets the Boolean value that indicates whether the Check Scanner device can create a file name for the image file automatically. (Inherited from CheckScanner) |
| CapAutoGenerateImageTagData |
Gets the Boolean value that indicates whether the Check Scanner device can generate tag data automatically. (Inherited from CheckScanner) |
| CapAutoSize |
Gets the Boolean value that indicates whether the size of the scanned document can be set automatically. (Inherited from CheckScanner) |
| CapColor |
Gets the Boolean value that indicates whether the Check Scanner device supports image formats other than bitonal. (Inherited from CheckScanner) |
| CapCompareFirmwareVersion | |
| CapConcurrentMicr |
Gets the Boolean value that indicates whether the Magnetic Ink Character Recognition (MICR) data can be captured. (Inherited from CheckScanner) |
| CapContrast |
Gets the Boolean value that indicates the ability of the device to lighten or darken the scanned image. (Inherited from CheckScanner) |
| CapDefineCropArea |
Gets the Boolean value that 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. (Inherited from CheckScanner) |
| CapImageFormat |
Gets the image file formats that this Check Scanner device supports. (Inherited from CheckScanner) |
| CapImageTagData |
Gets the Boolean value that indicates whether the Check Scanner device can set tag data. (Inherited from CheckScanner) |
| CapMicrDevice |
Gets the Boolean value that indicates whether the Check Scanner device supports a check Magnetic Ink Character Recognition (MICR) read function. (Inherited from CheckScanner) |
| CapPowerReporting | |
| CapStatisticsReporting | |
| CapStoreImageFiles |
Gets the Boolean value that indicates whether the Check Scanner device can store check images. (Inherited from CheckScanner) |
| CapUpdateFirmware | |
| CapUpdateStatistics | |
| CapValidationDevice |
Gets the Boolean value that indicates whether a check has to be removed before validation printing. (Inherited from CheckScanner) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | |
| Color |
Gets or sets the image scan mode for later document scan operations. (Inherited from CheckScanner) |
| CommonProperties | |
| Compatibility | (Inherited from PosDevice) |
| ConcurrentMicr |
Gets or sets the Boolean value that indicates whether the Check Scanner device can conduct a MICR read. (Inherited from CheckScanner) |
| Contrast |
Gets or sets the contrast to adjust the darkness of the image. (Inherited from CheckScanner) |
| CropAreaCount |
Gets the number of defined crop areas that may be applied to the captured image. (Inherited from CheckScanner) |
| DataCount | |
| DataEventEnabled | |
| DeviceDescription | |
| DeviceEnabled | |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DocumentHeight |
Gets or sets the height of the document scanned or the height of the document to be scanned. (Inherited from CheckScanner) |
| DocumentWidth |
Gets or sets the width of the document scanned or the width of the document to be scanned. (Inherited from CheckScanner) |
| ErrorCount | |
| ExternallyClaimed | |
| FileId |
Gets or sets the file name associated with the image data file. (Inherited from CheckScanner) |
| FileIndex |
Gets or sets the file location associated with the image data file. (Inherited from CheckScanner) |
| FreezeEvents | |
| HardwareId | (Inherited from PosCommon) |
| ImageData |
Gets the image data. (Inherited from CheckScanner) |
| ImageFormat |
Gets or sets the data format of the image file that the device uses when it captures an image. (Inherited from CheckScanner) |
| ImageMemoryStatus |
Gets the current memory availability status if the device can store multiple image files. (Inherited from CheckScanner) |
| ImageTagData |
Gets or sets a string that specifies the tag name for the captured image data. (Inherited from CheckScanner) |
| IsExclusiveUseDevice |
Gets the Boolean value that indicates whether the Check Scanner is an exclusive-use device. (Inherited from CheckScanner) |
| MapMode |
Gets or sets the units of measure that are currently valid for the Check Scanner device. (Inherited from CheckScanner) |
| MaxCropAreas |
Gets the maximum number of crop areas the device can support. (Inherited from CheckScanner) |
| PowerNotify | |
| PowerState | |
| Quality |
Gets or sets the resolution of the device when a scan image is to occur. The resolution value is defined as dpi (dots per inch). (Inherited from CheckScanner) |
| QualityList |
Gets the resolutions that the Check Scanner device can support. (Inherited from CheckScanner) |
| RemainingImagesEstimate |
Gets a "best guess" estimate of the remaining number of images that can be stored. (Inherited from CheckScanner) |
| ServiceObjectDescription | |
| ServiceObjectVersion | |
| State | |
| 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) |
Starts the document insertion process. (Inherited from CheckScanner) |
| BeginRemoval(Int32) |
Starts the document removal process. (Inherited from CheckScanner) |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | |
| ClearImage(CheckImageClear) |
Clears a specific image or all the images in the device memory. (Inherited from CheckScanner) |
| ClearInput() | |
| ClearInputImpl() | |
| ClearInputProperties() |
Resets the values of properties altered by DataEvent or ErrorEvent. (Inherited from CheckScanner) |
| Close() | |
| 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) | |
| CreateStatistic(String, Boolean) | |
| DefineCropArea(Int32, Int32, Int32, Int32, Int32) |
Establishes one or more cropping areas that can be applied to a scanned image. (Inherited from CheckScanner) |
| 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() | |
| Dispose(Boolean) | |
| EndInsertion() |
Ends the document insertion process. (Inherited from CheckScanner) |
| EndRemoval() |
Ends the document removal or ejection mode. (Inherited from CheckScanner) |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | |
| IncrementStatistic(String, Int32) | |
| IncrementStatistic(String) | |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() | |
| PreFireEvent(DataEventArgs) | |
| PreFireEvent(DeviceErrorEventArgs) | |
| PreFireEvent(DirectIOEventArgs) | |
| PreFireEvent(StatusUpdateEventArgs) | |
| QueueEvent(DataEventArgs) | |
| QueueEvent(DeviceErrorEventArgs) | |
| QueueEvent(DirectIOEventArgs) | |
| QueueEvent(StatusUpdateEventArgs) | |
| QueueEventAndWait(DeviceErrorEventArgs) | |
| QueueEventAndWait(DirectIOEventArgs) | |
| Release() | |
| ResetStatistic(String) | |
| ResetStatistics() | |
| ResetStatistics(StatisticCategories) | |
| ResetStatistics(String[]) | |
| RetrieveImage(Int32) |
Retrieves the most recently scanned image that resides in the available memory and uses it to populate the ImageData property. (Inherited from CheckScanner) |
| RetrieveMemory(CheckImageLocate) |
Retrieves an image that was stored in memory and uses it to set the ImageData property. (Inherited from CheckScanner) |
| RetrieveStatistic(String) | |
| RetrieveStatistics() | |
| RetrieveStatistics(StatisticCategories) | |
| RetrieveStatistics(String[]) | |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | |
| SetStatisticValue(String, Object) | |
| StoreImage(Int32) |
Stores an image or a cropped area of the image in the memory of the device. (Inherited from CheckScanner) |
| 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) | |
| UpdateStatistics(Statistic[]) | |
| UpdateStatistics(StatisticCategories, Object) | |
| VerifyState(Boolean, Boolean) | |
Events
| DataEvent | |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | |
| ErrorEvent | |
| StateChangedEvent | |
| StatusUpdateEvent | |