Msr 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.
Defines the programmatic interface for a UPOS magnetic stripe reader (MSR) device.
public abstract class Msr : Microsoft.PointOfService.PosCommontype Msr = class
inherit PosCommonPublic MustInherit Class Msr
Inherits PosCommon- Inheritance
- Derived
Constructors
| Msr() |
Creates an instance of the Msr class. |
Fields
| CardTypeAamva |
Indicates the card type is AAMVA. |
| CardTypeBank |
Indicates the card type is BANK. |
| ExtendedErrorDeviceAuthenticationFailed |
Indicates an extended error where the device authentication process failed. |
| ExtendedErrorDeviceDeauthenticationFailed |
Indicates an extended error where the device deauthentication failed. |
| ExtendedErrorEnd |
Indicates an end sentinel error. |
| ExtendedErrorFailure |
Indicates a general error. |
| 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) |
| ExtendedErrorLrc |
Indicates an LRC error. |
| ExtendedErrorParity |
Indicates a parity error. |
| ExtendedErrorStart |
Indicates a start sentinel error. |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| ExtendedErrorSuccess |
Indicates no error. |
| StatisticChallengeRequestCount |
Contains the count of challenge requests. |
| 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) |
| StatisticFailedCardAuthenticationDataCount |
Contains the count of failed card authentication attempts. |
| StatisticFailedDeviceAuthenticationCount |
Contains the count of failed device authentication attempts. |
| StatisticFailedReadCount |
This is field contains the node name used in the POS.NET XML statistics file. The number of failed card reads is stored in this node. |
| StatisticFailedWriteCount |
This is field contains a node name used in the POS.NET XML statistics file. The number of failed card writes is stored in this node. |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticGoodCardAuthenticationDataCount |
Contains the count of successful card authentication attempts. |
| StatisticGoodDeviceAuthenticationCount |
Contains the count of successful device authentication attempts. |
| StatisticGoodReadCount |
This is field contains the node name used in the POS.NET XML statistics file. The number of successful card reads is stored in this node. |
| StatisticGoodWriteCount |
This is field contains a node name used in the POS.NET XML statistics file. The number of successful card writes is stored in this node. |
| 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) |
| StatisticMissingStartSentinelTrack1Count |
This is field contains a node name used in the POS.NET XML statistics file. The number of times the track 1 sentinel was found missing is stored in this node. |
| StatisticMissingStartSentinelTrack2Count |
This is field contains a node name used in the POS.NET XML statistics file. The number of times the track 2 sentinel was found missing is stored in this node. |
| StatisticMissingStartSentinelTrack3Count |
This is field contains a node name used in the POS.NET XML statistics file. The number of times the track 3 sentinel was found missing is stored in this node. |
| StatisticMissingStartSentinelTrack4Count |
This is field contains a node name used in the POS.NET XML statistics file. The number of times the track 4 sentinel was found missing is stored in this node. |
| StatisticModelName |
Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon) |
| StatisticParityLrcErrorTrack1Count |
This is field contains the node name used in the POS.NET XML statistics file. The number of parity errors for track 1 is stored in this node. |
| StatisticParityLrcErrorTrack2Count |
This is field contains the node name used in the POS.NET XML statistics file. The number of parity errors for track 2 is stored in this node. |
| StatisticParityLrcErrorTrack3Count |
This is field contains the node name used in the POS.NET XML statistics file. The number of parity errors for track 3 is stored in this node. |
| StatisticParityLrcErrorTrack4Count |
This is field contains the node name used in the POS.NET XML statistics file. The number of parity errors for track 4 is stored in this node. |
| 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) |
| StatisticUnreadableCardCount |
This is field contains the node name used in the POS.NET XML statistics file. The number of failed card reads is stored in this node. |
| StatusDeviceAuthenticated |
Indicates if the device is authenticated. |
| StatusDeviceDeauthenticated |
Indicates if the device is deauthenticated. |
| 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) |
Properties
| AccountNumber |
Holds the account number from the most recently swiped card. |
| AdditionalSecurityInformation | |
| AutoDisable |
Indicates whether POS for .NET automatically disables the device when data is received. |
| CapCardAuthentication | |
| 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) |
| CapDataEncryption | |
| CapDeviceAuthentication | |
| CapIso |
If true, the MSR device supports ISO cards; otherwise it is false. |
| CapJisOne |
If true, the MSR device supports JIS Type-I cards; otherwise it is false. |
| CapJisTwo |
If true, the MSR device supports JIS Type-II cards; otherwise it is false. |
| 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) |
| CapTrackDataMasking | |
| CapTransmitSentinels |
If true, the MSR device can transmit start and end sentinels. If false, these characters cannot be returned to the application. |
| 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) |
| CapWritableTracks | |
| CardAuthenticationData | |
| CardAuthenticationDataLength | |
| CardPropertyList | |
| CardType | |
| CardTypeList | |
| 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) |
| Compatibility | (Inherited from PosDevice) |
| DataCount |
Holds the number of data events currently queued by the service object. |
| DataEncryptionAlgorithm | |
| DataEventEnabled |
When set to true by the application, POS for .NET delivers the next event in the event queue. |
| DecodeData |
If false, the Track1Data, Track2Data, Track3Data, and Track4Data properties contain the original encoded bit sequence, known as “raw format.” |
| DeviceAuthenticated | |
| DeviceAuthenticationProtocol | |
| 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) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName |
Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| EncodingMaxLength | |
| ErrorReportingType |
Holds the type of error reporting the application wants to receive. Possible values are defined by the MsrErrorReporting enumeration. |
| ExpirationDate |
Holds the expiration date from the most recently swiped card, as four ASCII decimal characters in the form YYMM. For example, February 1998 is “9802” and August 2018 is “1808”. |
| FirstName |
Holds the first name from the most recently swiped card. |
| FreezeEvents |
Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Indicates whether the Msr is an exclusive-use device. |
| MiddleInitial |
Holds the middle initial from the most recently swiped card. |
| ParseDecodeData |
If true, the decoded data contained within the Track1Data and Track2Data properties is further separated into fields for access via various other properties. |
| 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) |
| ServiceCode |
Holds the service code from the most recently swiped card. |
| 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) |
| Suffix |
Holds the suffix from the most recently swiped card. |
| Surname |
Holds the surname from the most recently swiped card. |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
| Title |
Holds the title from the most recently swiped card. |
| Track1Data |
Holds either the Track 1 data from the most recently swiped card or an empty array. |
| Track1DiscretionaryData |
Holds the Track 1 discretionary data from the most recently swiped card. |
| Track1EncryptedData | |
| Track1EncryptedDataLength | |
| Track2Data |
Holds either the Track 2 data from the most recently swiped card or an empty array. |
| Track2DiscretionaryData |
The Track 2 discretionary data from the most recently swiped card. |
| Track2EncryptedData | |
| Track2EncryptedDataLength | |
| Track3Data |
Holds either the Track 3 data from the most recently swiped card or an empty array. |
| Track3EncryptedData | |
| Track3EncryptedDataLength | |
| Track4Data |
Holds the Track 4 data (JIS-II) from the most recently swiped card. |
| Track4EncryptedData | |
| Track4EncryptedDataLength | |
| TracksToRead |
Indicates the track data that the application wishes to place into the Track1Data, Track2Data, Track3Data and Track4Data properties following a card swipe. |
| TracksToWrite |
Specifies which MSR tracks will be written when the WriteTracks(Byte[], Byte[], Byte[], Byte[], Int32) method is called and an MSR card swiped. |
| TransmitSentinels |
If true, the Track1Data, Track2Data, Track3Data, and Track4Data properties contain start sentinel and end sentinel values. |
| WriteCardType | |
Methods
| AuthenticateDevice(Byte[]) |
Authenticates a device. |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) |
Requests exclusive access to the device. (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(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) |
| DeauthenticateDevice(Byte[]) |
Deauthenticates a device that is currently in the authenticated state |
| 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) |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. (Inherited from PosCommon) |
| Release() |
Releases exclusive access to the device. (Inherited from PosCommon) |
| ResetStatistic(String) |
Resets the specified statistic to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics() |
Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(StatisticCategories) |
Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(String[]) |
Resets the specified statistics to 0 (zero). (Inherited from PosCommon) |
| RetrieveCardProperty(String) |
Retrieves the value of specific parsed properties from the last card swiped. |
| RetrieveDeviceAuthenticationData() | |
| RetrieveStatistic(String) |
Retrieves the specified device statistic. (Inherited from PosCommon) |
| RetrieveStatistics() |
Retrieves all device statistics. (Inherited from PosCommon) |
| RetrieveStatistics(StatisticCategories) |
Retrieves the statistics for the specified category. (Inherited from PosCommon) |
| RetrieveStatistics(String[]) |
Retrieves the specified statistics. (Inherited from PosCommon) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| 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) |
| UpdateKey(String, String) |
Provides a new encryption key to the device. |
| UpdateStatistic(String, Object) |
Updates the value of a specified device statistic. (Inherited from PosCommon) |
| UpdateStatistics(Statistic[]) |
Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon) |
| UpdateStatistics(StatisticCategories, Object) |
Updates the specified category of statistics with the specified value. (Inherited from PosCommon) |
| WriteTracks(Byte[], Byte[], Byte[], Byte[], Int32) |
Initiates the encoding of data to the MSR track(s) selected in the TracksToWrite property. |
Events
| DataEvent |
Raised by the service object to indicate the delivery of input data from the device to the application. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent |
Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon) |
| ErrorEvent |
Raised by the service object when an error is detected while trying to read MSR data. |
| StatusUpdateEvent |
Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon) |