Share via


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
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorBadData Indicates an unreadable character was detected during input processing.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorBadSize Indicates the length of the check was beyond the expected readable range.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorCheck Indicates the device was taken out of Removal mode while a check is still present.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorCheckDigit Indicates the check digit verification has failed even though there was no error during input processing.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorCoverOpen Indicates the check insertion process failed because of the POS printer cover being open.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif 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)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorJam Indicates the check insertion process has caused a paper jam.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorNoCheck Indicates the device was taken out of Insertion mode without a check being inserted.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorNoData Indicates the input data stream was unreadable.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorStatistics  Indicates a specified statistic could not be reset or updated. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ExtendedErrorStatisticsDependency  (inherited from PosCommon )
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticCommunicationErrorCount  Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticDeviceCategory  Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticFailedDataParseCount Contains the failed data parse count.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticFailedReadCount Contains the failed read count.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticFirmwareRevision  Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticGoodReadCount Contains the successful read count.
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticHoursPoweredCount  Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticInstallationDate  Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticInterface  Holds the programmatic name of the Interface common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticManufactureDate  Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticManufacturerName  Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticMechanicalRevision  Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticModelName  Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticSerialNumber  Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatisticUnifiedPOSVersion  Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusPowerOff  Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusPowerOffline  Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusPowerOffOffline  Indicates that either the device’s power is off or it is offline. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusPowerOnline  Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareComplete  Indicates the update firmware process has completed successfully. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif 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)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif 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)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceOk  Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnknown  Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnrecoverable  Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareProgress  Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon)
ms884554.pubfield(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif 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
ms884554.pubproperty(en-US,WinEmbedded.11).gif AccountNumber Gets the account number parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif Amount Gets the amount field parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif AutoDisable Gets or sets a Boolean value that indicates whether POS for .NET automatically disables the device when data is received.
ms884554.pubproperty(en-US,WinEmbedded.11).gif BankNumber Gets the bank number part of the transit field parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif 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)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CapPowerReporting  Gets the power reporting capabilities of the device. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CapStatisticsReporting  Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CapUpdateFirmware  Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif 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)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CapValidationDevice Gets a Boolean value that indicates whether this device also performs validation printing through the POS Printer service object's slip station.
ms884554.pubproperty(en-US,WinEmbedded.11).gif CheckHealthText  Gets a string that indicates the health of the device. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CheckType Gets a number that represents the type of check parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif Claimed  Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif Compatibility  Gets the compatibility level of a device. (inherited from PosDevice)
ms884554.pubproperty(en-US,WinEmbedded.11).gif CountryCode Gets a number that represents the country/region of origin of the check, parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif DataCount Gets the number of currently queued DataEvent events.
ms884554.pubproperty(en-US,WinEmbedded.11).gif DataEventEnabled Gets or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued.
ms884554.pubproperty(en-US,WinEmbedded.11).gif DeviceDescription  Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif DeviceEnabled  Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif DeviceName  Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif Epc Gets the Extended Processing Code ("EPC") field.
ms884554.pubproperty(en-US,WinEmbedded.11).gif FreezeEvents  Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif PowerNotify  Gets or sets the type of power notification selection made by the application. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif PowerState  Gets the current power condition. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif RawData Gets the MICR data from the most recent MICR read.
ms884554.pubproperty(en-US,WinEmbedded.11).gif SerialNumber Gets the serial number of the check parsed from the most recently read MICR data.
ms884554.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectDescription  Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectVersion  Gets the Service Object version number. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif State  Gets the current state of the device. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif SynchronizingObject  Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon)
ms884554.pubproperty(en-US,WinEmbedded.11).gif TransitNumber Gets the transit field of the check parsed from the most recently read MICR data.

Top

Protected Properties

  Name Description
ms884554.protproperty(en-US,WinEmbedded.11).gif DeviceInstanceId  (inherited from PosCommon )
ms884554.protproperty(en-US,WinEmbedded.11).gif DevicePath  Gets or sets the hardware path of a device. (inherited from PosCommon)
ms884554.protproperty(en-US,WinEmbedded.11).gif HardwareId  (inherited from PosCommon )
ms884554.protproperty(en-US,WinEmbedded.11).gif 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
ms884554.pubmethod(en-US,WinEmbedded.11).gif BeginInsertion Starts check insertion processing.
ms884554.pubmethod(en-US,WinEmbedded.11).gif BeginRemoval Starts the check removal processing.
ms884554.pubmethod(en-US,WinEmbedded.11).gif CheckHealth  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif Claim  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif ClearInput Clears all device input that has been buffered.
ms884554.pubmethod(en-US,WinEmbedded.11).gif ClearInputProperties Resets the values of properties altered by DataEvent or ErrorEvent.
ms884554.pubmethod(en-US,WinEmbedded.11).gif Close  Releases the device and its resources. (inherited from PosCommon)
ms884554.pubmethod(en-US,WinEmbedded.11).gif CompareFirmwareVersion  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif DirectIO  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif EndInsertion Ends the check insertion processing.
ms884554.pubmethod(en-US,WinEmbedded.11).gif EndRemoval Ends the check removal processing.
ms884554.pubmethod(en-US,WinEmbedded.11).gif Equals  Overloaded. (inherited from Object )
ms884554.pubmethod(en-US,WinEmbedded.11).gif GetHashCode  (inherited from Object )
ms884554.pubmethod(en-US,WinEmbedded.11).gif GetType  (inherited from Object )
ms884554.pubmethod(en-US,WinEmbedded.11).gif Open  Opens a device for later input/output processing. (inherited from PosCommon)
ms884554.pubmethod(en-US,WinEmbedded.11).gifms884554.static(en-US,WinEmbedded.11).gif ReferenceEquals  (inherited from Object )
ms884554.pubmethod(en-US,WinEmbedded.11).gif Release  Releases exclusive access to the device. (inherited from PosCommon)
ms884554.pubmethod(en-US,WinEmbedded.11).gif ResetStatistic  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif ResetStatistics  Overloaded. (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistic  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistics  Overloaded. (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif ToString  (inherited from Object )
ms884554.pubmethod(en-US,WinEmbedded.11).gif UpdateFirmware  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistic  (inherited from PosCommon )
ms884554.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistics  Overloaded. (inherited from PosCommon )

Top

Protected Methods

  Name Description
ms884554.protmethod(en-US,WinEmbedded.11).gif DeleteConfigurationProperty  (inherited from PosCommon )
ms884554.protmethod(en-US,WinEmbedded.11).gif Finalize  (inherited from Object )
ms884554.protmethod(en-US,WinEmbedded.11).gif GetConfigurationProperty  (inherited from PosCommon )
ms884554.protmethod(en-US,WinEmbedded.11).gif Invoke  (inherited from PosCommon )
ms884554.protmethod(en-US,WinEmbedded.11).gif MemberwiseClone  (inherited from Object )
ms884554.protmethod(en-US,WinEmbedded.11).gif SetConfigurationProperty  (inherited from PosCommon )

Top

Public Events

(see also Protected Events )

  Name Description
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.
ms884554.pubevent(en-US,WinEmbedded.11).gif DirectIOEvent  Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon)
ms884554.pubevent(en-US,WinEmbedded.11).gif ErrorEvent Raised by the service object to notify the application that an error has been detected when it reads MICR data.
ms884554.pubevent(en-US,WinEmbedded.11).gif StatusUpdateEvent  Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon)

Top

Protected Events

  Name Description
ms884554.protevent(en-US,WinEmbedded.11).gif DeviceAddedEvent  (inherited from PosCommon )
ms884554.protevent(en-US,WinEmbedded.11).gif DeviceRemovedEvent  (inherited from PosCommon )

Top

See Also

Reference

Micr Class
Microsoft.PointOfService Namespace