CashChanger 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.
Defines the programmatic interface for a UPOS Cash Changer device.
public abstract class CashChanger : Microsoft.PointOfService.PosCommontype CashChanger = class
inherit PosCommonPublic MustInherit Class CashChanger
Inherits PosCommon- Inheritance
- Derived
Constructors
| CashChanger() |
Creates an instance of CashChanger 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) |
| ExtendedErrorOverDispense |
Indicates that the specified cash cannot be dispensed because of a cash shortage. |
| 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) |
| 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) |
| StatusAsync |
Indicates that an asynchronously performed method has finished. |
| StatusEmpty |
Indicates that some cash slots are empty. |
| StatusEmptyOK |
Indicates that no cash slots are empty or almost empty. |
| StatusFull |
Indicates that some cash slots are full. |
| StatusFullOK |
Indicates that no cash slots are full or almost full. |
| StatusJam |
Indicates that a mechanical fault has occurred. |
| StatusJamOK |
Indicates that a mechanical fault has recovered. |
| StatusNearEmpty |
Indicates that some cash slots are almost empty. |
| StatusNearFull |
Indicates that some cash slots are almost full. |
| StatusOK |
Indicates that the device is ready to dispense coinage. |
| 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
| AsyncMode |
Gets or sets a Boolean value that indicates whether CashChanger methods are performed asynchronously. |
| AsyncResultCode |
Gets the completion status of the last asynchronous dispense request. |
| AsyncResultCodeExtended |
Gets the completion status of the last asynchronous dispense request. |
| 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) |
| CapDeposit |
Gets a Boolean value that indicates whether the device supports cash acceptance. |
| CapDepositDataEvent |
Gets a Boolean value that indicates whether the device can report cash acceptance events. |
| CapDiscrepancy |
Gets a Boolean value that indicates whether ReadCashCounts() can report effective Discrepancy values. |
| CapEmptySensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are empty. |
| CapFullSensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are full. |
| CapJamSensor |
Gets a Boolean value that indicates whether the device can report that a mechanical fault has occurred in the cash changer. |
| CapNearEmptySensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are almost empty. |
| CapNearFullSensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are almost full. |
| CapPauseDeposit |
Gets a Boolean value that indicates whether the device can suspend cash acceptance. |
| CapPowerReporting |
Gets the power reporting capabilities of the device. (Inherited from PosCommon) |
| CapRealTimeData |
Gets a Boolean value that indicates whether the device may supply data as the money is being accepted. |
| CapRepayDeposit |
Gets a Boolean value that indicates whether the device can return deposited money. |
| CapStatisticsReporting |
Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon) |
| 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) |
| 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 | (Inherited from PosDevice) |
| CurrencyCashList |
Gets a list of cash units supported in the cash changer for the currency represented by the CurrencyCode property. |
| CurrencyCode |
Gets or sets the active currency code to be used by cash changer operations. |
| CurrencyCodeList |
Gets a list of ASCII 3-character ISO 4217 currency codes, separated by commas. |
| CurrentExit |
Gets or sets a value that indicates the current cash-dispensing exit. |
| CurrentService |
Gets or sets the current service. |
| DataCount |
Gets the number of currently queued DataEvent events. |
| DataEventEnabled |
Gets or sets a Boolean value that indicates whether a DataEvent event can be delivered when input data is queued. |
| DepositAmount |
Gets the total amount of cash accepted. |
| DepositCashList |
Gets the cash units supported in the cash changer for the currency represented by the CurrencyCode property. |
| DepositCodeList |
Gets a list of the currency code indicators for the cash accepted. |
| DepositCounts |
Gets the total of the cash accepted by the cash units. |
| DepositStatus |
Gets the current status of the cash acceptance operation. |
| 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) |
| DeviceExits |
Gets the number of exits for dispensing cash. |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName |
Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DeviceStatus |
Gets the current status of the cash changer. |
| ExitCashList |
Gets the cash units that can be dispensed to the exit denoted by the CurrentExit property. |
| FreezeEvents |
Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon) |
| FullStatus |
Gets the current full status of the cash slots. |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Gets a Boolean value that indicated whether the Cash Changer is an exclusive-use device. |
| 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) |
| RealTimeDataEnabled | |
| ServiceCount | |
| ServiceIndex | |
| 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) |
| 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
| AdjustCashCounts(IEnumerable<CashCount>) |
Sets the initial amount of cash after setup or adjusts cash counts after replenishment or removal. |
| BeginDeposit() |
Starts a cash acceptance operation. |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) |
Requests exclusive access to the device. (Inherited from PosCommon) |
| ClearInput() |
Clears all device input that has been buffered. |
| Close() |
Releases the device and its resources. (Inherited from PosCommon) |
| 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) |
| 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) |
| DispenseCash(CashCount[]) |
Dispenses the specified cash units and cash counts from the device. |
| DispenseChange(Int32) |
Dispenses the specified amount of cash. |
| EndDeposit(CashDepositAction) |
Completes a cash acceptance operation. |
| FixDeposit() |
Updates property values to reflect the current values in the device. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. (Inherited from PosCommon) |
| PauseDeposit(CashDepositPause) |
Suspends or resumes depositing cash. |
| ReadCashCounts() |
Reads the current cash counts. |
| Release() |
Releases exclusive access to the device. (Inherited from PosCommon) |
| ResetStatistic(String) |
Resets the specified statistic to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics() |
Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(StatisticCategories) |
Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(String[]) |
Resets the specified statistics to 0 (zero). (Inherited from PosCommon) |
| RetrieveStatistic(String) |
Retrieves the specified device statistic. (Inherited from PosCommon) |
| RetrieveStatistics() |
Retrieves all device statistics. (Inherited from PosCommon) |
| RetrieveStatistics(StatisticCategories) |
Retrieves the statistics for the specified category. (Inherited from PosCommon) |
| RetrieveStatistics(String[]) |
Retrieves the specified statistics. (Inherited from PosCommon) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| 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) |
Updates the value of a specified device statistic. (Inherited from PosCommon) |
| UpdateStatistics(Statistic[]) |
Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon) |
| UpdateStatistics(StatisticCategories, Object) |
Updates the specified category of statistics with the specified value. (Inherited from PosCommon) |
Events
| DataEvent |
Raised by the service object to notify the application when the cash changer has a status change. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent |
Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon) |
| StatusUpdateEvent |
Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon) |