Msr Members

2/27/2008

Defines the programmatic interface for a UPOS magnetic stripe reader (MSR) device.

The following tables list the members exposed by the Msr type.

Protected Constructors

	Name	Description
	Msr	Creates an instance of the Msr class.

Top

Public Fields

	Name	Description
	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)

Top

Public Properties

(see also Protected Properties )

	Name	Description
	AccountNumber	Holds the account number from the most recently swiped card.
	AdditionalSecurityInformation	Gets additional security/encryption information when a DataEvent is delivered.
	AutoDisable	Indicates whether POS for .NET automatically disables the device when data is received.
	CapCardAuthentication	Gets the type, if any, of card authentication data that is supported by the device.
	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	Gets a bitwise indication of the encryption algorithms supported by the device and is selectable via the DataEncryptionAlgorithm property.
	CapDeviceAuthentication	Gets the level of device authentication supported by the service.
	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	Gets a Boolean value that indicates whether the service supports track data masking.
	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	Indicates if the MSR device supports the writing of track data, and which tracks are supported.
	CardAuthenticationData	Gets the card authentication information when a DataEvent is delivered.
	CardAuthenticationDataLength	Gets the length of the raw CardAuthenticationData before it is encrypted.
	CardPropertyList	Gets a comma separated list of the names of the properties parsed from the most recently swiped card.
	CardType	Gets the card type identifier for the most recently swiped card.
	CardTypeList	Gets a comma separated list of string names of card types supported by the service.
	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	Gets the compatibility level of a device. (inherited from PosDevice)
	DataCount	Holds the number of data events currently queued by the service object.
	DataEncryptionAlgorithm	Gets and sets the encryption algorithm that will be used to encrypt the track data.
	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	Gets a Boolean value that indicates whether the device supports authentication.
	DeviceAuthenticationProtocol	Gets the device authentication protocol supported by the device.
	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)
	EncodingMaxLength	Holds the maximum length of data that can be written by the MSR to the track or tracks defined by the TracksToWrite property.
	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)
	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	Gets the length of the raw Track1Data before it is encrypted.
	Track1EncryptedDataLength	Gets the encrypted track 1 data obtained from the most recently swiped card.
	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	Holds the length of the raw Track2Data before it is encrypted.
	Track2EncryptedDataLength	Gets the encrypted track 2 data obtained from the most recently swiped card.
	Track3Data	Holds either the Track 3 data from the most recently swiped card or an empty array.
	Track3EncryptedData	Gets the length of the raw Track3Data before it is encrypted.
	Track3EncryptedDataLength	Gets the encrypted track 3 data obtained from the most recently swiped card.
	Track4Data	Holds the Track 4 data (JIS-II) from the most recently swiped card.
	Track4EncryptedData	Gets the encrypted track 4 data obtained from the most recently swiped card.
	Track4EncryptedDataLength	Gets the length of the raw Track4Data before it is encrypted.
	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 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	Holds the card type to be used the next time the WriteTracks method is called.

Top

Protected Properties

	Name	Description
	DeviceInstanceId	(inherited from PosCommon )
	DevicePath	Gets or sets the hardware path of a device. (inherited from PosCommon)
	HardwareId	(inherited from PosCommon )
	IsExclusiveUseDevice	Overridden. Indicates whether the Msr is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

	Name	Description
	AuthenticateDevice	Authenticates a device.
	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 )
	DeauthenticateDevice	Deauthenticates a device that is currently in the authenticated state
	DirectIO	(inherited from PosCommon )
	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 )
	RetrieveCardProperty	Retrieves the value of specific parsed properties from the last card swiped.
	RetrieveDeviceAuthenticationData	Applications call this method to retrieve a challenge token that will subsequently be used to generate response tokens that will be passed to the AuthenticateDevice and DeauthenticateDevice methods.
	RetrieveStatistic	(inherited from PosCommon )
	RetrieveStatistics	Overloaded. (inherited from PosCommon )
	ToString	(inherited from Object )
	UpdateFirmware	(inherited from PosCommon )
	UpdateKey	Provides a new encryption key to the device.
	UpdateStatistic	(inherited from PosCommon )
	UpdateStatistics	Overloaded. (inherited from PosCommon )
	WriteTracks	Initiates the encoding of data to the MSR track(s) selected in the TracksToWrite property.

Top

Protected Methods

	Name	Description
	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
	DataEvent	Raised by the service object to indicate the delivery of input data from the device to the application.
	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)

Top

Protected Events

	Name	Description
	DeviceAddedEvent	(inherited from PosCommon )
	DeviceRemovedEvent	(inherited from PosCommon )

Top

See Also

Reference

Msr Class
Microsoft.PointOfService Namespace