Micr Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Defines the programmatic interface for a UPOS magnetic ink character recognition (MICR) device.
The following tables list the members exposed by the Micr type.
Protected Constructors
| Name | Description | |
|---|---|---|
| Micr | Creates an instance of the Micr class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "ms884554.pubfield(en-US,WinEmbedded.11).gif") .gif "ms884554.static(en-US,WinEmbedded.11).gif") |
ExtendedErrorBadData | Indicates an unreadable character was detected during input processing. |
|
ExtendedErrorBadSize | Indicates the length of the check was beyond the expected readable range. |
|
ExtendedErrorCheck | Indicates the device was taken out of Removal mode while a check is still present. |
|
ExtendedErrorCheckDigit | Indicates the check digit verification has failed even though there was no error during input processing. |
|
ExtendedErrorCoverOpen | Indicates the check insertion process failed because of the POS printer cover being open. |
|
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) |
|
ExtendedErrorJam | Indicates the check insertion process has caused a paper jam. |
|
ExtendedErrorNoCheck | Indicates the device was taken out of Insertion mode without a check being inserted. |
|
ExtendedErrorNoData | Indicates the input data stream was unreadable. |
|
ExtendedErrorStatistics | Indicates a specified statistic could not be reset or updated. (inherited from PosCommon) |
|
ExtendedErrorStatisticsDependency | (inherited from PosCommon ) |
|
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) |
|
StatisticFailedDataParseCount | Contains the failed data parse count. |
|
StatisticFailedReadCount | Contains the failed read count. |
|
StatisticFirmwareRevision | Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon) |
|
StatisticGoodReadCount | Contains the successful read count. |
|
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) |
|
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 "ms884554.pubproperty(en-US,WinEmbedded.11).gif") |
AccountNumber | Gets the account number parsed from the most recently read MICR data. |
|
Amount | Gets the amount field parsed from the most recently read MICR data. |
|
AutoDisable | Gets or sets a Boolean value that indicates whether POS for .NET automatically disables the device when data is received. |
|
BankNumber | Gets the bank number part of the transit field parsed from the most recently read MICR data. |
|
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) |
|
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) |
|
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 a Boolean value that indicates whether this device also performs validation printing through the POS Printer service object's slip station. |
|
CheckHealthText | Gets a string that indicates the health of the device. (inherited from PosCommon) |
|
CheckType | Gets a number that represents the type of check parsed from the most recently read MICR data. |
|
Claimed | Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon) |
|
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) |
|
CountryCode | Gets a number that represents the country/region of origin of the check, parsed from the most recently read MICR data. |
|
DataCount | Gets the number of currently queued DataEvent events. |
|
DataEventEnabled | Gets or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued. |
|
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) |
|
Epc | Gets the Extended Processing Code ("EPC") field. |
|
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon) |
|
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) |
|
RawData | Gets the MICR data from the most recent MICR read. |
|
SerialNumber | Gets the serial number of the check parsed from the most recently read MICR data. |
|
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) |
|
TransitNumber | Gets the transit field of the check parsed from the most recently read MICR data. |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms884554.protproperty(en-US,WinEmbedded.11).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 a Boolean value that indicates whether the Micr is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms884554.pubmethod(en-US,WinEmbedded.11).gif") |
BeginInsertion | Starts check insertion processing. |
|
BeginRemoval | Starts the check removal processing. |
|
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PosCommon ) |
|
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 ) |
|
DirectIO | (inherited from PosCommon ) |
|
EndInsertion | Ends the check insertion processing. |
|
EndRemoval | Ends the check removal processing. |
|
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 ) |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms884554.protmethod(en-US,WinEmbedded.11).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 "ms884554.pubevent(en-US,WinEmbedded.11).gif") |
DataEvent | Raised by the service object to notify the application when MICR data is read from a check and is available to read. |
|
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon) |
|
ErrorEvent | Raised by the service object to notify the application that an error has been detected when it reads MICR 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 "ms884554.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top