Share via


MsrBasic Class

Definition

public abstract class MsrBasic : Microsoft.PointOfService.Msr, IDisposable
type MsrBasic = class
    inherit Msr
    interface IDisposable
Public MustInherit Class MsrBasic
Inherits Msr
Implements IDisposable
Inheritance
Derived
Implements

Constructors

MsrBasic()

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.

(Inherited from Msr)
AdditionalSecurityInformation (Inherited from Msr)
AutoDisable
CapCardAuthentication (Inherited from Msr)
CapCompareFirmwareVersion
CapDataEncryption (Inherited from Msr)
CapDeviceAuthentication (Inherited from Msr)
CapIso

If true, the MSR device supports ISO cards; otherwise it is false.

(Inherited from Msr)
CapJisOne

If true, the MSR device supports JIS Type-I cards; otherwise it is false.

(Inherited from Msr)
CapJisTwo

If true, the MSR device supports JIS Type-II cards; otherwise it is false.

(Inherited from Msr)
CapPowerReporting
CapStatisticsReporting
CapTrackDataMasking (Inherited from Msr)
CapTransmitSentinels

If true, the MSR device can transmit start and end sentinels. If false, these characters cannot be returned to the application.

(Inherited from Msr)
CapUpdateFirmware
CapUpdateStatistics
CapWritableTracks (Inherited from Msr)
CardAuthenticationData (Inherited from Msr)
CardAuthenticationDataLength (Inherited from Msr)
CardPropertyList (Inherited from Msr)
CardType (Inherited from Msr)
CardTypeList (Inherited from Msr)
CheckHealthText

Gets a string that indicates the health of the device.

(Inherited from PosCommon)
Claimed
CommonProperties
Compatibility (Inherited from PosDevice)
DataCount
DataEncryptionAlgorithm (Inherited from Msr)
DataEventEnabled
DecodeData

If false, the Track1Data, Track2Data, Track3Data, and Track4Data properties contain the original encoded bit sequence, known as “raw format.”

(Inherited from Msr)
DeviceAuthenticated (Inherited from Msr)
DeviceAuthenticationProtocol (Inherited from Msr)
DeviceDescription
DeviceEnabled
DeviceInstanceId (Inherited from PosCommon)
DeviceName
DevicePath

Gets or sets the hardware path of a device.

(Inherited from PosCommon)
EncodingMaxLength (Inherited from Msr)
ErrorCount
ErrorReportingType

Holds the type of error reporting the application wants to receive. Possible values are defined by the MsrErrorReporting enumeration.

(Inherited from Msr)
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”.

(Inherited from Msr)
ExternallyClaimed
FirstName

Holds the first name from the most recently swiped card.

(Inherited from Msr)
FreezeEvents
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.

(Inherited from Msr)
ParseDecodeData

If true, the decoded data contained within the Track1Data and Track2Data properties is further separated into fields for access via various other properties.

(Inherited from Msr)
PowerNotify
PowerState
ServiceCode

Holds the service code from the most recently swiped card.

(Inherited from Msr)
ServiceObjectDescription
ServiceObjectVersion
State
Suffix

Holds the suffix from the most recently swiped card.

(Inherited from Msr)
Surname

Holds the surname from the most recently swiped card.

(Inherited from Msr)
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.

(Inherited from Msr)
Track1Data

Holds either the Track 1 data from the most recently swiped card or an empty array.

(Inherited from Msr)
Track1DiscretionaryData

Holds the Track 1 discretionary data from the most recently swiped card.

(Inherited from Msr)
Track1EncryptedData (Inherited from Msr)
Track1EncryptedDataLength (Inherited from Msr)
Track2Data

Holds either the Track 2 data from the most recently swiped card or an empty array.

(Inherited from Msr)
Track2DiscretionaryData

The Track 2 discretionary data from the most recently swiped card.

(Inherited from Msr)
Track2EncryptedData (Inherited from Msr)
Track2EncryptedDataLength (Inherited from Msr)
Track3Data

Holds either the Track 3 data from the most recently swiped card or an empty array.

(Inherited from Msr)
Track3EncryptedData (Inherited from Msr)
Track3EncryptedDataLength (Inherited from Msr)
Track4Data

Holds the Track 4 data (JIS-II) from the most recently swiped card.

(Inherited from Msr)
Track4EncryptedData (Inherited from Msr)
Track4EncryptedDataLength (Inherited from Msr)
TracksToRead

Indicates the track data that the application wishes to place into the Track1Data, Track2Data, Track3Data and Track4Data properties following a card swipe.

(Inherited from Msr)
TracksToWrite

Specifies which MSR tracks will be written when the WriteTracks(Byte[], Byte[], Byte[], Byte[], Int32) method is called and an MSR card swiped.

(Inherited from Msr)
TransmitSentinels

If true, the Track1Data, Track2Data, Track3Data, and Track4Data properties contain start sentinel and end sentinel values.

(Inherited from Msr)
WriteCardType (Inherited from Msr)

Methods

AuthenticateDevice(Byte[])

Authenticates a device.

(Inherited from Msr)
CheckHealth(HealthCheckLevel)

Tests the state of a device.

(Inherited from PosCommon)
Claim(Int32)
ClearInput()
ClearInputImpl()
ClearInputProperties()

Resets the values of properties altered by DataEvent or ErrorEvent.

(Inherited from Msr)
Close()
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, String)
CreateStatistic(String, Boolean)
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()
Dispose(Boolean)
GetConfigurationProperty(String)

Used by the Service Object to retrieve the specified property from the XML configuration file.

(Inherited from PosCommon)
GetStatisticValue(String)
IncrementStatistic(String, Int32)
IncrementStatistic(String)
Invoke(Delegate, Object[])

Used by the Service Objects to raise an event.

(Inherited from PosCommon)
Open()
PreFireEvent(DataEventArgs)
PreFireEvent(DeviceErrorEventArgs)
PreFireEvent(DirectIOEventArgs)
PreFireEvent(StatusUpdateEventArgs)
QueueEvent(DataEventArgs)
QueueEvent(DeviceErrorEventArgs)
QueueEvent(DirectIOEventArgs)
QueueEvent(StatusUpdateEventArgs)
QueueEventAndWait(DeviceErrorEventArgs)
QueueEventAndWait(DirectIOEventArgs)
Release()
ResetStatistic(String)
ResetStatistics()
ResetStatistics(StatisticCategories)
ResetStatistics(String[])
RetrieveCardProperty(String)

Retrieves the value of specific parsed properties from the last card swiped.

(Inherited from Msr)
RetrieveDeviceAuthenticationData() (Inherited from Msr)
RetrieveStatistic(String)
RetrieveStatistics()
RetrieveStatistics(StatisticCategories)
RetrieveStatistics(String[])
SetConfigurationProperty(String, String)

Sets a property value (or create a new property) in the XML configuration file.

(Inherited from PosCommon)
SetStatisticHandlers(String, GetStatistic, SetStatistic)
SetStatisticValue(String, Object)
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)
UpdateStatistics(Statistic[])
UpdateStatistics(StatisticCategories, Object)
VerifyState(Boolean, Boolean)
WriteTracks(Byte[], Byte[], Byte[], Byte[], Int32)

Initiates the encoding of data to the MSR track(s) selected in the TracksToWrite property.

(Inherited from Msr)

Events

DataEvent
DeviceAddedEvent (Inherited from PosCommon)
DeviceRemovedEvent (Inherited from PosCommon)
DirectIOEvent
ErrorEvent
StateChangedEvent
StatusUpdateEvent

Applies to