CheckScanner Members
2/27/2008
Defines the programmatic interface for a UPOS Check Scanner device.
The following tables list the members exposed by the CheckScanner type.
Protected Constructors
| Name | Description | |
|---|---|---|
| CheckScanner | Creates an instance of the CheckScanner class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "ms884004.pubfield(en-us,WinEmbedded.1002).gif") .gif "ms884004.static(en-us,WinEmbedded.1002).gif") |
AutomaticContrast | Indicates the device can automatically adjust the contrast of the image. |
| |
CropAreaBottom | Indicates that the y endpoint value of the scanned image is set to the value of the DocumentHeight property. |
| |
CropAreaEntireImage | Indicates the crop area is equal to the scanned image. |
| |
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. |
| |
CropAreaRight | Indicates that the x endpoint value of a scanned image are set to the value of the DocumentWidth property. |
| |
ExtendedErrorCheck | Indicates that a check was detected in the check scanner device. |
| |
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. |
| |
ExtendedErrorNoRoom | Indicates there is no room for the scanned image to be stored in memory. |
| |
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. |
| |
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. |
| |
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) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms884004.pubproperty(en-us,WinEmbedded.1002).gif") |
AutoDisable | Gets or sets the Boolean value that indicates whether POS for .NET automatically disables the device when data is received. |
|
CapAutoContrast | Gets the Boolean value that indicates whether the contrast can be adjusted automatically. |
|
CapAutoGenerateFileId | Gets the Boolean value that indicates whether the Check Scanner device can create a file name for the image file automatically. |
|
CapAutoGenerateImageTagData | Gets the Boolean value that indicates whether the Check Scanner device can generate tag data automatically. |
|
CapAutoSize | Gets the Boolean value that indicates whether the size of the scanned document can be set automatically. |
|
CapColor | Gets the Boolean value that indicates whether the Check Scanner device supports image formats other than bitonal. |
|
CapCompareFirmwareVersion | Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (inherited from PosCommon) |
|
CapConcurrentMicr | Gets the Boolean value that indicates whether the Magnetic Ink Character Recognition (MICR) data can be captured. |
|
CapContrast | Gets the Boolean value that indicates the ability of the device to lighten or darken the scanned image. |
|
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. |
|
CapImageFormat | Gets the image file formats that this Check Scanner device supports. |
|
CapImageTagData | Gets the Boolean value that indicates whether the Check Scanner device can set tag data. |
|
CapMicrDevice | Gets the Boolean value that indicates whether the Check Scanner device supports a check Magnetic Ink Character Recognition (MICR) read function. |
|
CapPowerReporting | Gets the power reporting capabilities of the device. (inherited from PosCommon) |
|
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon) |
|
CapStoreImageFiles | Gets the Boolean value that indicates whether the Check Scanner device can store check images. |
|
CapUpdateFirmware | Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon) |
|
CapUpdateStatistics | Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (inherited from PosCommon) |
|
CapValidationDevice | Gets the Boolean value that indicates whether a check has to be removed before validation printing. |
|
CheckHealthText | Gets a string that indicates the health of the device. (inherited from PosCommon) |
|
Claimed | Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon) |
|
Color | Gets or sets the image scan mode for later document scan operations. |
|
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) |
|
ConcurrentMicr | Gets or sets the Boolean value that indicates whether the Check Scanner device can conduct a MICR read. |
|
Contrast | Gets or sets the contrast to adjust the darkness of the image. |
|
CropAreaCount | Gets the number of defined crop areas that may be applied to the captured image. |
|
DataCount | Gets the number of data events currently queued by the service object. |
|
DataEventEnabled | Gets or sets the Boolean value that indicates whether the service object can deliver a queued event. |
|
DeviceDescription | Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon) |
|
DeviceEnabled | Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon) |
|
DocumentHeight | Gets or sets the height of the document scanned or the height of the document to be scanned. |
|
DocumentWidth | Gets or sets the width of the document scanned or the width of the document to be scanned. |
|
FileId | Gets or sets the file name associated with the image data file. |
|
FileIndex | Gets or sets the file location associated with the image data file. |
|
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon) |
|
ImageData | Gets the image data. |
|
ImageFormat | Gets or sets the data format of the image file that the device uses when it captures an image. |
|
ImageMemoryStatus | Gets the current memory availability status if the device can store multiple image files. |
|
ImageTagData | Gets or sets a string that specifies the tag name for the captured image data. |
|
MapMode | Gets or sets the units of measure that are currently valid for the Check Scanner device. |
|
MaxCropAreas | Gets the maximum number of crop areas the device can support. |
|
PowerNotify | Gets or sets the type of power notification selection made by the application. (inherited from PosCommon) |
|
PowerState | Gets the current power condition. (inherited from PosCommon) |
|
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). |
|
QualityList | Gets the resolutions that the Check Scanner device can support. |
|
RemainingImagesEstimate | Gets a "best guess" estimate of the remaining number of images that can be stored. |
|
ServiceObjectDescription | Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon) |
|
ServiceObjectVersion | Gets the Service Object version number. (inherited from PosCommon) |
|
State | Gets the current state of the device. (inherited from PosCommon) |
|
SynchronizingObject | Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms884004.protproperty(en-us,WinEmbedded.1002).gif") |
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Overridden. Gets the Boolean value that indicates whether the Check Scanner is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms884004.pubmethod(en-us,WinEmbedded.1002).gif") |
BeginInsertion | Starts the document insertion process. |
|
BeginRemoval | Starts the document removal process. |
|
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PosCommon ) |
|
ClearImage | Clears a specific image or all the images in the device memory. |
|
ClearInput | Clears all device input that has been buffered. |
|
ClearInputProperties | Resets the values of properties altered by DataEvent or ErrorEvent. |
|
Close | Releases the device and its resources. (inherited from PosCommon) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
DefineCropArea | Establishes one or more cropping areas that can be applied to a scanned image. |
|
DirectIO | (inherited from PosCommon ) |
|
EndInsertion | Ends the document insertion process. |
|
EndRemoval | Ends the document removal or ejection mode. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
| |
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
RetrieveImage | Retrieves the most recently scanned image that resides in the available memory and uses it to populate the ImageData property. |
|
RetrieveMemory | Retrieves an image that was stored in memory and uses it to set the ImageData property. |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
StoreImage | Stores an image or a cropped area of the image in the memory of the device. |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms884004.protmethod(en-us,WinEmbedded.1002).gif") |
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "ms884004.pubevent(en-us,WinEmbedded.1002).gif") |
DataEvent | Raised to notify the application that a scanned check image is available. |
|
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon) |
|
ErrorEvent | Raised to indicate an error has been detected while trying to read keyboard device input data. |
|
StatusUpdateEvent | Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "ms884004.protevent(en-us,WinEmbedded.1002).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top