PinPadBase Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Implements all properties and methods for supporting PIN pad devices.
The following tables list the members exposed by the PinPadBase type.
Protected Constructors
| Name | Description | |
|---|---|---|
| PinPadBase | Creates an instance of the PinPadBase class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "Aa460652.pubfield(en-US,WinEmbedded.11).gif") .gif "Aa460652.static(en-US,WinEmbedded.11).gif") |
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) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "Aa460652.pubproperty(en-US,WinEmbedded.11).gif") |
AccountNumber | Overridden. Holds the user’s account number for the current EFT transaction. |
|
AdditionalSecurityInformation | Overridden. 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 | Overridden. Holds the amount of the current EFT transaction. |
|
AvailableLanguagesList | Overridden. 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 | Overridden. Holds a comma-separated string of supported values for the Prompt property. |
|
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 PinPadBasic) |
|
CapDisplay | Overridden. Indicates the operations that the application can perform on the PIN pad display. |
|
CapKeyboard | Overridden. If set to true, the application can use the PIN pad keyboard to obtain input. |
|
CapLanguage | Overridden. Indicates the language of pre-defined messages for the PIN pad device (for example, English, French, Arabic, and so on). |
|
CapMacCalculation | Overridden. If set to true, the PIN pad supports MAC calculation. |
|
CapPowerReporting | Gets the power reporting capabilities of the device. (inherited from PinPadBasic) |
|
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PinPadBasic) |
|
CapTone | Overridden. If set to true, the PIN pad has a tone indicator, which is implemented as a ToneIndicator class object. |
|
CapUpdateFirmware | Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PinPadBasic) |
|
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 PinPadBasic) |
|
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 PinPadBasic) |
|
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) |
|
DataCount | Holds the number of data events currently queued by the service object. (inherited from PinPadBasic) |
|
DataEventEnabled | When set to true by the application, the service object can deliver the next queued DataEvent event. (inherited from PinPadBasic) |
|
DeviceDescription | Gets a string identifying the device and the company that manufactured it. (inherited from PinPadBasic) |
|
DeviceEnabled | Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PinPadBasic) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (inherited from PinPadBasic) |
|
EncryptedPin | Overridden. Holds the value of the encrypted PIN after the DataEvent event notifies the application that a PIN entry operation has been completed. |
|
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PinPadBasic) |
|
MaximumPinLength | Overridden. Holds the maximum acceptable number of digits to be entered for the PIN. |
|
MerchantId | Overridden. Holds the Merchant ID, as it is known to the EFT Transaction Host. |
|
MinimumPinLength | Overridden. Holds the minimum acceptable number of digits to be entered for a PIN. |
|
PinEntryEnabled | Overridden. Indicates whether the PinPad is ready to accept PIN entry. |
|
PowerNotify | Gets or sets the type of power notification selection made by the application. (inherited from PinPadBasic) |
|
PowerState | Gets the current power condition. (inherited from PinPadBasic) |
|
Prompt | Overridden. Holds a pre-defined message to be displayed on the PIN Pad. |
|
PromptLanguage | Overridden. Specifies the language in which the message specified by the Prompt property will be displayed, as defined by the CultureInfo .NET Framework class. |
|
ServiceObjectDescription | Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PinPadBasic) |
|
ServiceObjectVersion | Gets the Service Object version number. (inherited from PinPadBasic) |
|
State | Gets the current state of the device. (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 | Overridden. Holds the Terminal ID, as it is known to the EFT Transaction Host. |
|
Track1Data | Overridden. Holds either the decoded Track 1 data from the previous card swipe or an empty string. |
|
Track2Data | Overridden. Holds either the decoded Track 2 data from the previous card swipe or an empty string. |
|
Track3Data | Overridden. Holds either the decoded Track 3 data from the previous card swipe or an empty string. |
|
Track4Data | Overridden. Holds either the decoded Track 4 data from the previous card swipe or an empty string. |
|
TransactionType | Overridden. Holds the current EFT transaction type. |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "Aa460652.protproperty(en-US,WinEmbedded.11).gif") |
CommonProperties | (inherited from PinPadBasic ) |
|
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
ErrorCount | (inherited from PinPadBasic ) |
|
ExternallyClaimed | (inherited from PinPadBasic ) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Indicates whether the PinPad is an exclusive-use device. (inherited from PinPad) |
|
Properties | Contains getters and setters for PinPadBase and Common properties. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "Aa460652.pubmethod(en-US,WinEmbedded.11).gif") |
BeginEftTransaction | Overridden. Informs the PIN Pad’s service object that an EFT Transaction is starting. |
|
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PinPadBasic ) |
|
ClearInput | (inherited from PinPadBasic ) |
|
ClearInputProperties | Overridden. Resets the values of properties altered by DataEvent or ErrorEvent. |
|
Close | Releases the device and its resources. (inherited from PinPadBasic) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
ComputeMac | Overridden. Tells the service object to compute a MAC value and return it to the application. |
|
DirectIO | (inherited from PosCommon ) |
|
Dispose | Overloaded. |
|
EnablePinEntry | Overridden. Starts PIN entry at the PIN pad device. |
|
EndEftTransaction | Overridden. Takes the PIN pad out of EFT Transaction Mode. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Open | Overridden. Opens a device for later input/output processing. |
|
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PinPadBasic) |
|
ResetStatistic | (inherited from PinPadBasic ) |
|
ResetStatistics | Overloaded. (inherited from PinPadBasic ) |
|
RetrieveStatistic | (inherited from PinPadBasic ) |
|
RetrieveStatistics | Overloaded. (inherited from PinPadBasic ) |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateKey | Overridden. 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. |
|
UpdateStatistic | (inherited from PinPadBasic ) |
|
UpdateStatistics | Overloaded. (inherited from PinPadBasic ) |
|
VerifyMac | Overridden. Tells the service object to verify the MAC value in a message received from an EFT Transaction Host. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "Aa460652.protmethod(en-US,WinEmbedded.11).gif") |
BeginEftTransactionImpl | Informs the PIN Pad’s service object that an EFT Transaction is starting. |
|
ClearInputImpl | (inherited from PinPadBasic ) |
|
ComputeMacImpl | The PinPadBase class calls ComputeMacImpl from its ComputeMac method. |
|
CreateStatistic | Overloaded. (inherited from PinPadBasic ) |
|
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Dispose | Overloaded. Overridden. |
|
EnablePinEntryImpl | The PinPadBase class calls EnablePinEntryImpl from its EnablePinEntry method. |
|
EndEftTransactionImpl | The PinPadBase class calls EndEftTransactionImpl from its EndEftTransaction method. |
|
ExitPinEntryMode | Overloaded. |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
GetStatisticValue | (inherited from PinPadBasic ) |
|
IncrementStatistic | Overloaded. (inherited from PinPadBasic ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
PreFireEvent | Overloaded. Overridden. |
|
QueueEvent | Overloaded. (inherited from PinPadBasic ) |
|
QueueEventAndWait | Overloaded. (inherited from PinPadBasic ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
|
SetStatisticHandlers | (inherited from PinPadBasic ) |
|
SetStatisticValue | (inherited from PinPadBasic ) |
|
UpdateKeyImpl | The PinPadBase class calls UpdateKeyImpl from its UpdateKey method. |
|
VerifyMacImpl | The PinPadBase class calls VerifyMacImpl from its VerifyMac method. |
|
VerifyState | (inherited from PinPadBasic ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "Aa460652.pubevent(en-US,WinEmbedded.11).gif") |
DataEvent | Raised by the service object to present input data from the PIN pad device to the application. (inherited from PinPadBasic) |
|
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PinPadBasic) |
|
ErrorEvent | Raised by the service object when an error is detected while trying to perform a PIN encryption function. (inherited from PinPadBasic) |
|
StatusUpdateEvent | Raised by the Service Object to alert the application of a device status change. (inherited from PinPadBasic) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "Aa460652.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
|
StateChangedEvent | (inherited from PinPadBasic ) |
Top
See Also
Reference
PinPadBase Class
Microsoft.PointOfService.BaseServiceObjects Namespace