PinPadBase 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.
Implements all properties and methods for supporting PIN pad devices.
public abstract class PinPadBase : Microsoft.PointOfService.BasicServiceObjects.PinPadBasictype PinPadBase = class
inherit PinPadBasicPublic MustInherit Class PinPadBase
Inherits PinPadBasic- Inheritance
Constructors
| PinPadBase() |
Creates an instance of the PinPadBase class. |
Fields
| ExtendedErrorBadKey |
Indicates that an encryption key is corrupted or missing. (Inherited from PinPad) |
| 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) |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| 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) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| 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) |
| StatisticInvalidPINEntryCount |
Incremented during the ExitPinEntryMode method if PIN entry has failed. (Inherited from PinPad) |
| 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) |
| StatisticModelName |
Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon) |
| 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) |
| StatisticValidPINEntryCount |
Incremented during the ExitPinEntryMode method if PIN entry has occurred successfully. (Inherited from PinPad) |
| 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 user’s account number for the current EFT transaction. |
| AdditionalSecurityInformation |
Holds security/encryption information, formatted as a Hex-ASCII string, after a successful PIN entry operation in which the DataEvent event is queued to the application with a DataEventArgs.Status of Success. |
| Amount |
Holds the amount of the current EFT transaction. |
| AvailableLanguagesList |
Holds an array of the languages supported by the pre-defined prompts in the PIN pad device, as defined by the CultureInfo .NET Framework Class. |
| AvailablePromptsList |
Holds a comma-separated string of supported values for the Prompt property. |
| CapCompareFirmwareVersion | (Inherited from PinPadBasic) |
| CapDisplay |
Indicates the operations that the application can perform on the PIN pad display. |
| CapKeyboard |
If set to true, the application can use the PIN pad keyboard to obtain input. |
| CapLanguage |
Indicates the language of pre-defined messages for the PIN pad device (for example, English, French, Arabic, and so on). |
| CapMacCalculation |
If set to true, the PIN pad supports MAC calculation. |
| CapPowerReporting | (Inherited from PinPadBasic) |
| CapStatisticsReporting | (Inherited from PinPadBasic) |
| CapTone |
If set to true, the PIN pad has a tone indicator, which is implemented as a ToneIndicator class object. |
| CapUpdateFirmware | (Inherited from PinPadBasic) |
| CapUpdateStatistics | (Inherited from PinPadBasic) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from PinPadBasic) |
| CommonProperties | (Inherited from PinPadBasic) |
| Compatibility | (Inherited from PosDevice) |
| DataCount | (Inherited from PinPadBasic) |
| DataEventEnabled | (Inherited from PinPadBasic) |
| DeviceDescription | (Inherited from PinPadBasic) |
| DeviceEnabled | (Inherited from PinPadBasic) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from PinPadBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| EncryptedPin |
Holds the value of the encrypted PIN after the DataEvent event notifies the application that a PIN entry operation has been completed. |
| ErrorCount | (Inherited from PinPadBasic) |
| ExternallyClaimed | (Inherited from PinPadBasic) |
| FreezeEvents | (Inherited from PinPadBasic) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Indicates whether the PinPad is an exclusive-use device. (Inherited from PinPad) |
| MaximumPinLength |
Holds the maximum acceptable number of digits to be entered for the PIN. |
| MerchantId |
Holds the Merchant ID, as it is known to the EFT Transaction Host. |
| MinimumPinLength |
Holds the minimum acceptable number of digits to be entered for a PIN. |
| PinEntryEnabled |
Indicates whether the PinPad is ready to accept PIN entry. |
| PowerNotify | (Inherited from PinPadBasic) |
| PowerState | (Inherited from PinPadBasic) |
| Prompt |
Holds a pre-defined message to be displayed on the PIN Pad. |
| PromptLanguage |
Specifies the language in which the message specified by the Prompt property will be displayed, as defined by the CultureInfo .NET Framework class. |
| Properties |
Contains getters and setters for PinPadBase and Common properties. |
| ServiceObjectDescription | (Inherited from PinPadBasic) |
| ServiceObjectVersion | (Inherited from PinPadBasic) |
| State | (Inherited from PinPadBasic) |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
| TerminalId |
Holds the Terminal ID, as it is known to the EFT Transaction Host. |
| Track1Data |
Holds either the decoded Track 1 data from the previous card swipe or an empty string. |
| Track2Data |
Holds either the decoded Track 2 data from the previous card swipe or an empty string. |
| Track3Data |
Holds either the decoded Track 3 data from the previous card swipe or an empty string. |
| Track4Data |
Holds either the decoded Track 4 data from the previous card swipe or an empty string. |
| TransactionType |
Holds the current EFT transaction type. |
Methods
| BeginEftTransaction(PinPadSystem, Int32) |
Informs the PIN Pad’s service object that an EFT Transaction is starting. |
| BeginEftTransaction(String, Int32) | |
| BeginEftTransactionImpl(PinPadSystem, Int32) |
Informs the PIN Pad’s service object that an EFT Transaction is starting. |
| BeginEftTransactionImpl2(String, Int32) | |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | (Inherited from PinPadBasic) |
| ClearInput() | (Inherited from PinPadBasic) |
| ClearInputImpl() | (Inherited from PinPadBasic) |
| ClearInputProperties() |
Resets the values of properties altered by DataEvent or ErrorEvent. |
| Close() | (Inherited from PinPadBasic) |
| 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) |
| ComputeMac(String) |
Tells the service object to compute a MAC value and return it to the application. |
| ComputeMacImpl(String) |
The PinPadBase class calls ComputeMacImpl from its ComputeMac method. |
| CreateStatistic(String, Boolean, String) | (Inherited from PinPadBasic) |
| CreateStatistic(String, Boolean) | (Inherited from PinPadBasic) |
| 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 PinPadBasic) |
| Dispose(Boolean) | |
| EnablePinEntry() |
Starts PIN entry at the PIN pad device. |
| EnablePinEntryImpl() |
The PinPadBase class calls EnablePinEntryImpl from its EnablePinEntry method. |
| EndEftTransaction(EftTransactionCompletion) |
Takes the PIN pad out of EFT Transaction Mode. |
| EndEftTransactionImpl(EftTransactionCompletion) |
The PinPadBase class calls EndEftTransactionImpl from its EndEftTransaction method. |
| ExitPinEntryMode(ErrorCode, Int32) | |
| ExitPinEntryMode(PinEntryStatus, String, String) |
Called by the service object to exit PIN entry mode. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from PinPadBasic) |
| IncrementStatistic(String, Int32) | (Inherited from PinPadBasic) |
| IncrementStatistic(String) | (Inherited from PinPadBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. |
| PreFireEvent(DataEventArgs) |
Called prior to the delivery of a DataEvent event to the application. |
| PreFireEvent(DeviceErrorEventArgs) | (Inherited from PinPadBasic) |
| PreFireEvent(DirectIOEventArgs) | (Inherited from PinPadBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from PinPadBasic) |
| QueueEvent(DataEventArgs) | (Inherited from PinPadBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from PinPadBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from PinPadBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from PinPadBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from PinPadBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from PinPadBasic) |
| Release() | (Inherited from PinPadBasic) |
| ResetStatistic(String) | (Inherited from PinPadBasic) |
| ResetStatistics() | (Inherited from PinPadBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from PinPadBasic) |
| ResetStatistics(String[]) | (Inherited from PinPadBasic) |
| RetrieveStatistic(String) | (Inherited from PinPadBasic) |
| RetrieveStatistics() | (Inherited from PinPadBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from PinPadBasic) |
| RetrieveStatistics(String[]) | (Inherited from PinPadBasic) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | (Inherited from PinPadBasic) |
| SetStatisticValue(String, Object) | (Inherited from PinPadBasic) |
| 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(Int32, String) |
Provides a new encryption key to the PIN pad service object for those PIN Pad Management Systems in which new key values are sent to the terminal as a field in standard messages from the EFT Transaction Host. |
| UpdateKeyImpl(Int32, String) |
The PinPadBase class calls UpdateKeyImpl from its UpdateKey method. |
| UpdateStatistic(String, Object) | (Inherited from PinPadBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from PinPadBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from PinPadBasic) |
| VerifyMac(String) |
Tells the service object to verify the MAC value in a message received from an EFT Transaction Host. |
| VerifyMacImpl(String) |
The PinPadBase class calls VerifyMacImpl from its VerifyMac method. |
| VerifyState(Boolean, Boolean) | (Inherited from PinPadBasic) |
Events
| DataEvent | (Inherited from PinPadBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from PinPadBasic) |
| ErrorEvent | (Inherited from PinPadBasic) |
| StateChangedEvent | (Inherited from PinPadBasic) |
| StatusUpdateEvent | (Inherited from PinPadBasic) |