CashDrawerBase 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.
Exposes functionality required for support of cash drawer devices.
public abstract class CashDrawerBase : Microsoft.PointOfService.BasicServiceObjects.CashDrawerBasictype CashDrawerBase = class
inherit CashDrawerBasicPublic MustInherit Class CashDrawerBase
Inherits CashDrawerBasic- Inheritance
Constructors
| CashDrawerBase() |
Creates an instance of the CashDrawerBase. |
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) |
| StatisticDrawerFailedOpenCount |
Incremented during the OpenDrawer method if the cash drawer does not open. (Inherited from CashDrawer) |
| StatisticDrawerGoodOpenCount |
Incremented during the OpenDrawer method if the cash drawer successfully opens. (Inherited from CashDrawer) |
| 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) |
| 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) |
| StatusClosed |
Indicates that the cash drawer is closed. (Inherited from CashDrawer) |
| StatusOpen |
Indicates that the cash drawer is open. (Inherited from CashDrawer) |
| 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
| CapCompareFirmwareVersion | (Inherited from CashDrawerBasic) |
| CapPowerReporting | (Inherited from CashDrawerBasic) |
| CapStatisticsReporting | (Inherited from CashDrawerBasic) |
| CapStatus |
Indicates that the drawer can report its status. |
| CapStatusMultiDrawerDetect |
Indicates that statuses unique to each drawer in multi-drawer configurations can be reported. |
| CapUpdateFirmware | (Inherited from CashDrawerBasic) |
| CapUpdateStatistics | (Inherited from CashDrawerBasic) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from CashDrawerBasic) |
| CommonProperties | (Inherited from CashDrawerBasic) |
| Compatibility | (Inherited from PosDevice) |
| DeviceDescription | (Inherited from CashDrawerBasic) |
| DeviceEnabled | |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from CashDrawerBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DrawerOpened |
Indicates whether the drawer is open. |
| ExternallyClaimed | (Inherited from CashDrawerBasic) |
| FreezeEvents | (Inherited from CashDrawerBasic) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Gets the Boolean value that indicates whether the Cash Drawer is an exclusive-use device. (Inherited from CashDrawer) |
| PowerNotify | (Inherited from CashDrawerBasic) |
| PowerState | (Inherited from CashDrawerBasic) |
| Properties |
Returns an instance of the CashDrawerProperties helper class, containing getters and setters for cash drawer and common properties. |
| ServiceObjectDescription | (Inherited from CashDrawerBasic) |
| ServiceObjectVersion | (Inherited from CashDrawerBasic) |
| State | (Inherited from CashDrawerBasic) |
| 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 CashDrawerBasic) |
| Close() |
Releases the device and its resources. |
| 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) | (Inherited from CashDrawerBasic) |
| CreateStatistic(String, Boolean, String) | (Inherited from CashDrawerBasic) |
| 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 CashDrawerBasic) |
| 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 CashDrawerBasic) |
| IncrementStatistic(String) | (Inherited from CashDrawerBasic) |
| IncrementStatistic(String, Int32) | (Inherited from CashDrawerBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for subsequent input/output processing. |
| OpenDrawer() |
Physically opens the cash drawer. |
| OpenDrawerImpl() |
Implemented by the service object to physically open the cash drawer. |
| PreFireEvent(DirectIOEventArgs) | (Inherited from CashDrawerBasic) |
| PreFireEvent(StatusUpdateEventArgs) |
Updates the DrawerOpened property and informs applications using the cash drawer of the status change. |
| QueueEvent(DirectIOEventArgs) | (Inherited from CashDrawerBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from CashDrawerBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from CashDrawerBasic) |
| Release() | (Inherited from CashDrawerBasic) |
| ResetStatistic(String) | (Inherited from CashDrawerBasic) |
| ResetStatistics() | (Inherited from CashDrawerBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from CashDrawerBasic) |
| ResetStatistics(String[]) | (Inherited from CashDrawerBasic) |
| RetrieveStatistic(String) | (Inherited from CashDrawerBasic) |
| RetrieveStatistics() | (Inherited from CashDrawerBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from CashDrawerBasic) |
| RetrieveStatistics(String[]) | (Inherited from CashDrawerBasic) |
| 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 CashDrawerBasic) |
| SetStatisticValue(String, Object) | (Inherited from CashDrawerBasic) |
| 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 CashDrawerBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from CashDrawerBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from CashDrawerBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from CashDrawerBasic) |
| WaitForDrawerClose(Int32, Int32, Int32, Int32) |
The application calls WaitForDrawerClose(Int32, Int32, Int32, Int32) to wait until the cash drawer is closed. |
Events
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from CashDrawerBasic) |
| OnDrawerStateChanged |
The CashDrawerBase class raises OnDrawerStateChanged events to inform the service object that the value of the CashDrawerProperties.DrawerOpened property has been updated and the application has been notified of a drawer status change. |
| StateChangedEvent | (Inherited from CashDrawerBasic) |
| StatusUpdateEvent | (Inherited from CashDrawerBasic) |