PosKeyboardBase 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 compete device functionality implemented by POS for .NET for support of keyboard devices.
public abstract class PosKeyboardBase : Microsoft.PointOfService.BasicServiceObjects.PosKeyboardBasictype PosKeyboardBase = class
inherit PosKeyboardBasicPublic MustInherit Class PosKeyboardBase
Inherits PosKeyboardBasic- Inheritance
Constructors
| PosKeyboardBase() |
Creates an instance of the PosKeyboardBase class. |
Fields
| 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) |
| StatisticKeyPressedCount |
Incremented for each key-down action. (Inherited from PosKeyboard) |
| 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) |
| 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
| AutoDisable | (Inherited from PosKeyboardBasic) |
| CapCompareFirmwareVersion | (Inherited from PosKeyboardBasic) |
| CapKeyUp |
If true, the keyboard device is able to generate both key-down and key-up input data, based on the value of the EventTypes property. |
| CapPowerReporting | (Inherited from PosKeyboardBasic) |
| CapStatisticsReporting | (Inherited from PosKeyboardBasic) |
| CapUpdateFirmware | (Inherited from PosKeyboardBasic) |
| CapUpdateStatistics | (Inherited from PosKeyboardBasic) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from PosKeyboardBasic) |
| CommonProperties | (Inherited from PosKeyboardBasic) |
| Compatibility | (Inherited from PosDevice) |
| DataCount | (Inherited from PosKeyboardBasic) |
| DataEventEnabled | (Inherited from PosKeyboardBasic) |
| DeviceDescription | (Inherited from PosKeyboardBasic) |
| DeviceEnabled | (Inherited from PosKeyboardBasic) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from PosKeyboardBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| ErrorCount | (Inherited from PosKeyboardBasic) |
| EventTypes |
Holds the type of events that the application wants to receive. |
| ExternallyClaimed | (Inherited from PosKeyboardBasic) |
| FreezeEvents | (Inherited from PosKeyboardBasic) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice | (Inherited from PosKeyboard) |
| PosKeyData |
Holds the value of the key from the last DataEvent. |
| PosKeyEventType |
Holds the value of the key from the last DataEvent. |
| PowerNotify | (Inherited from PosKeyboardBasic) |
| PowerState | (Inherited from PosKeyboardBasic) |
| Properties |
Contains getters and setters for PosKeyboard and Common properties. |
| ServiceObjectDescription | (Inherited from PosKeyboardBasic) |
| ServiceObjectVersion | (Inherited from PosKeyboardBasic) |
| State | (Inherited from PosKeyboardBasic) |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
Methods
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | (Inherited from PosKeyboardBasic) |
| ClearInput() | (Inherited from PosKeyboardBasic) |
| ClearInputImpl() | (Inherited from PosKeyboardBasic) |
| Close() | (Inherited from PosKeyboardBasic) |
| 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) | (Inherited from PosKeyboardBasic) |
| CreateStatistic(String, Boolean) | (Inherited from PosKeyboardBasic) |
| 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 PosKeyboardBasic) |
| Dispose(Boolean) | |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from PosKeyboardBasic) |
| IncrementStatistic(String, Int32) | (Inherited from PosKeyboardBasic) |
| IncrementStatistic(String) | (Inherited from PosKeyboardBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| KeyDown(Int32) |
Holds the type of the last keyboard event. |
| KeyUp(Int32) |
If true, the keyboard device is able to generate both key-down and key-up input data, based on the value of the EventTypes property. |
| 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 PosKeyboardBasic) |
| PreFireEvent(DirectIOEventArgs) | (Inherited from PosKeyboardBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEvent(DataEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from PosKeyboardBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from PosKeyboardBasic) |
| Release() | (Inherited from PosKeyboardBasic) |
| ResetStatistic(String) | (Inherited from PosKeyboardBasic) |
| ResetStatistics() | (Inherited from PosKeyboardBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from PosKeyboardBasic) |
| ResetStatistics(String[]) | (Inherited from PosKeyboardBasic) |
| RetrieveStatistic(String) | (Inherited from PosKeyboardBasic) |
| RetrieveStatistics() | (Inherited from PosKeyboardBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from PosKeyboardBasic) |
| RetrieveStatistics(String[]) | (Inherited from PosKeyboardBasic) |
| 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 PosKeyboardBasic) |
| SetStatisticValue(String, Object) | (Inherited from PosKeyboardBasic) |
| 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) |
| UpdateStatistic(String, Object) | (Inherited from PosKeyboardBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from PosKeyboardBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from PosKeyboardBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from PosKeyboardBasic) |
Events
| DataEvent | (Inherited from PosKeyboardBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from PosKeyboardBasic) |
| ErrorEvent | (Inherited from PosKeyboardBasic) |
| StateChangedEvent | (Inherited from PosKeyboardBasic) |
| StatusUpdateEvent | (Inherited from PosKeyboardBasic) |