MsrBase 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.
Contains most of the functionality for support of MSR devices.
public abstract class MsrBase : Microsoft.PointOfService.BasicServiceObjects.MsrBasictype MsrBase = class
inherit MsrBasicPublic MustInherit Class MsrBase
Inherits MsrBasic- Inheritance
Constructors
| MsrBase() |
Creates a new instance of the MsrBase class. |
Fields
| CardTypeAamva |
Indicates the card type is AAMVA. (Inherited from Msr) |
| CardTypeBank |
Indicates the card type is BANK. (Inherited from Msr) |
| ExtendedErrorDeviceAuthenticationFailed |
Indicates an extended error where the device authentication process failed. (Inherited from Msr) |
| ExtendedErrorDeviceDeauthenticationFailed |
Indicates an extended error where the device deauthentication failed. (Inherited from Msr) |
| ExtendedErrorEnd |
Indicates an end sentinel error. (Inherited from Msr) |
| ExtendedErrorFailure |
Indicates a general error. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| ExtendedErrorParity |
Indicates a parity error. (Inherited from Msr) |
| ExtendedErrorStart |
Indicates a start sentinel error. (Inherited from Msr) |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| ExtendedErrorSuccess |
Indicates no error. (Inherited from Msr) |
| StatisticChallengeRequestCount |
Contains the count of challenge requests. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| StatisticFailedDeviceAuthenticationCount |
Contains the count of failed device authentication attempts. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticGoodCardAuthenticationDataCount |
Contains the count of successful card authentication attempts. (Inherited from Msr) |
| StatisticGoodDeviceAuthenticationCount |
Contains the count of successful device authentication attempts. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| 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. (Inherited from Msr) |
| StatusDeviceAuthenticated |
Indicates if the device is authenticated. (Inherited from Msr) |
| StatusDeviceDeauthenticated |
Indicates if the device is deauthenticated. (Inherited from Msr) |
| 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 | (Inherited from MsrBasic) |
| CapCardAuthentication | |
| CapCompareFirmwareVersion | (Inherited from MsrBasic) |
| CapDataEncryption | |
| CapDeviceAuthentication | |
| CapIso |
Indicates that the MSR supports ISO cards. |
| CapJisOne |
Indicates that the MSR device supports JIS Type-I cards. |
| CapJisTwo |
Indicates that the MSR device supports JIS Type-II cards. |
| CapPowerReporting | (Inherited from MsrBasic) |
| CapStatisticsReporting | (Inherited from MsrBasic) |
| CapTrackDataMasking | |
| CapTransmitSentinels |
Indicates that the MSR device can transmit start and end sentinels. |
| CapUpdateFirmware | (Inherited from MsrBasic) |
| CapUpdateStatistics | (Inherited from MsrBasic) |
| CapWritableTracks | |
| CardAuthenticationData | |
| CardAuthenticationDataLength | |
| CardPropertyList | |
| CardType | |
| CardTypeList | |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from MsrBasic) |
| CommonProperties | (Inherited from MsrBasic) |
| Compatibility | (Inherited from PosDevice) |
| DataCount | (Inherited from MsrBasic) |
| DataEncryptionAlgorithm | |
| DataEventEnabled | (Inherited from MsrBasic) |
| DecodeData |
If false, the Track1Data, Track2Data, Track3Data, and Track4Data properties contain the original encoded bit sequence, known as “raw format.” |
| DeviceAuthenticated | |
| DeviceAuthenticationProtocol | |
| DeviceDescription | (Inherited from MsrBasic) |
| DeviceEnabled | (Inherited from MsrBasic) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from MsrBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| EncodingMaxLength | |
| ErrorCount | (Inherited from MsrBasic) |
| 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. |
| ExternallyClaimed | (Inherited from MsrBasic) |
| FirstName |
Holds the first name from the most recently swiped card. |
| FreezeEvents | (Inherited from MsrBasic) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Indicates whether the Msr is an exclusive-use device. (Inherited from Msr) |
| 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 | (Inherited from MsrBasic) |
| PowerState | (Inherited from MsrBasic) |
| Properties |
Contains getters and setters for common and Msr specific properties. |
| ServiceCode |
Holds the service code from the most recently swiped card. |
| ServiceObjectDescription | (Inherited from MsrBasic) |
| ServiceObjectVersion | (Inherited from MsrBasic) |
| State | (Inherited from MsrBasic) |
| 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 | |
| TransmitSentinels |
Indicates that the Track1Data, Track2Data, Track3Data, and Track4Data properties contain start sentinel and end sentinel values. |
| WriteCardType | |
Methods
| AuthenticateDevice(Byte[]) |
Authenticates a device. (Inherited from Msr) |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | (Inherited from MsrBasic) |
| ClearInput() | (Inherited from MsrBasic) |
| ClearInputImpl() | (Inherited from MsrBasic) |
| ClearInputProperties() |
Resets the values of properties altered by DataEvent or ErrorEvent. |
| Close() | (Inherited from MsrBasic) |
| 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) | (Inherited from MsrBasic) |
| CreateStatistic(String, Boolean, String) | (Inherited from MsrBasic) |
| DeauthenticateDevice(Byte[]) |
Deauthenticates a device that is currently in the authenticated state (Inherited from Msr) |
| 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() | (Inherited from MsrBasic) |
| Dispose(Boolean) | |
| FailedRead(Byte[], Byte[], Byte[], Byte[], CardType, ErrorCode, Int32) |
Called by the service object when an error occurs while the MSR device is attempting to read card data. |
| FailedRead(Byte[], Byte[], Byte[], Byte[], CardType, ErrorCode, Int32, Byte[]) | |
| FailedRead(Byte[], Byte[], Byte[], Byte[], CardType, ErrorCode, Int32, Byte[], Byte[], Int32) | |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from MsrBasic) |
| GoodRead(Byte[], Byte[], Byte[], Byte[], CardType) |
Called by the service object when the card swipe has been successful. |
| GoodRead(Byte[], Int32, Byte[], Int32, Byte[], Int32, Byte[], Int32, Byte[], Byte[], Byte[], Byte[], CardType, Byte[], Byte[], Int32) | |
| GoodRead(Byte[], Int32, Byte[], Int32, Byte[], Int32, Byte[], Int32, CardType, Byte[]) | |
| IncrementStatistic(String) | (Inherited from MsrBasic) |
| IncrementStatistic(String, Int32) | (Inherited from MsrBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Initializes MSR properties DecodeData, ParseDecodeData, TransmitSentinels, ErrorReprtingType, and MsrTracksToRead. |
| ParseMsrFieldData(Byte[], Byte[], Byte[], Byte[], CardType) |
Called to decode card data into the appropriate properties. |
| ParseMsrTrackData(Byte[], Byte[], Byte[], Byte[], CardType) |
Called to decode card data into the appropriate properties. |
| PreFireEvent(DataEventArgs) |
Called prior to the delivery of a DataEvent event to the application. |
| PreFireEvent(DeviceErrorEventArgs) |
Called prior to the delivery of a DeviceErrorEvent event to the application. |
| PreFireEvent(DirectIOEventArgs) | (Inherited from MsrBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from MsrBasic) |
| QueueEvent(DataEventArgs) | (Inherited from MsrBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from MsrBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from MsrBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from MsrBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from MsrBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from MsrBasic) |
| Release() | (Inherited from MsrBasic) |
| ResetStatistic(String) | (Inherited from MsrBasic) |
| ResetStatistics() | (Inherited from MsrBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from MsrBasic) |
| ResetStatistics(String[]) | (Inherited from MsrBasic) |
| RetrieveCardProperty(String) | |
| RetrieveDeviceAuthenticationData() | (Inherited from Msr) |
| RetrieveStatistic(String) | (Inherited from MsrBasic) |
| RetrieveStatistics() | (Inherited from MsrBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from MsrBasic) |
| RetrieveStatistics(String[]) | (Inherited from MsrBasic) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetMaxTrackEncodingLengths(Int32, Int32, Int32, Int32) |
Sets the maximum encoding length for the specified Msr data tracks. |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | (Inherited from MsrBasic) |
| SetStatisticValue(String, Object) | (Inherited from MsrBasic) |
| UnreadableCard(ErrorCode, Int32) |
Called by the service object when the card data is unreadable. |
| 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. (Inherited from Msr) |
| UpdateStatistic(String, Object) | (Inherited from MsrBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from MsrBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from MsrBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from MsrBasic) |
| WriteTracks(Byte[], Byte[], Byte[], Byte[], Int32) |
Initiates the encoding of data to the MSR track(s) selected in the TracksToWrite property. |
| WriteTracksImpl(Byte[], Byte[], Byte[], Byte[], Int32) | |
Events
| DataEvent | (Inherited from MsrBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from MsrBasic) |
| ErrorEvent | (Inherited from MsrBasic) |
| StateChangedEvent | (Inherited from MsrBasic) |
| StatusUpdateEvent | (Inherited from MsrBasic) |