CashChangerBasic 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.
public abstract class CashChangerBasic : Microsoft.PointOfService.CashChanger, IDisposabletype CashChangerBasic = class
inherit CashChanger
interface IDisposablePublic MustInherit Class CashChangerBasic
Inherits CashChanger
Implements IDisposable- Inheritance
- Implements
Constructors
| CashChangerBasic() |
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. (Inherited from CashChanger) |
| 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. (Inherited from CashChanger) |
| StatusEmpty |
Indicates that some cash slots are empty. (Inherited from CashChanger) |
| StatusEmptyOK |
Indicates that no cash slots are empty or almost empty. (Inherited from CashChanger) |
| StatusFull |
Indicates that some cash slots are full. (Inherited from CashChanger) |
| StatusFullOK |
Indicates that no cash slots are full or almost full. (Inherited from CashChanger) |
| StatusJam |
Indicates that a mechanical fault has occurred. (Inherited from CashChanger) |
| StatusJamOK |
Indicates that a mechanical fault has recovered. (Inherited from CashChanger) |
| StatusNearEmpty |
Indicates that some cash slots are almost empty. (Inherited from CashChanger) |
| StatusNearFull |
Indicates that some cash slots are almost full. (Inherited from CashChanger) |
| StatusOK |
Indicates that the device is ready to dispense coinage. (Inherited from CashChanger) |
| 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. (Inherited from CashChanger) |
| AsyncResultCode |
Gets the completion status of the last asynchronous dispense request. (Inherited from CashChanger) |
| AsyncResultCodeExtended |
Gets the completion status of the last asynchronous dispense request. (Inherited from CashChanger) |
| CapCompareFirmwareVersion | |
| CapDeposit |
Gets a Boolean value that indicates whether the device supports cash acceptance. (Inherited from CashChanger) |
| CapDepositDataEvent |
Gets a Boolean value that indicates whether the device can report cash acceptance events. (Inherited from CashChanger) |
| CapDiscrepancy |
Gets a Boolean value that indicates whether ReadCashCounts() can report effective Discrepancy values. (Inherited from CashChanger) |
| CapEmptySensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are empty. (Inherited from CashChanger) |
| CapFullSensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are full. (Inherited from CashChanger) |
| CapJamSensor |
Gets a Boolean value that indicates whether the device can report that a mechanical fault has occurred in the cash changer. (Inherited from CashChanger) |
| CapNearEmptySensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are almost empty. (Inherited from CashChanger) |
| CapNearFullSensor |
Gets a Boolean value that indicates whether the device can report that some cash slots are almost full. (Inherited from CashChanger) |
| CapPauseDeposit |
Gets a Boolean value that indicates whether the device can suspend cash acceptance. (Inherited from CashChanger) |
| CapPowerReporting | |
| CapRealTimeData |
Gets a Boolean value that indicates whether the device may supply data as the money is being accepted. (Inherited from CashChanger) |
| CapRepayDeposit |
Gets a Boolean value that indicates whether the device can return deposited money. (Inherited from CashChanger) |
| CapStatisticsReporting | |
| CapUpdateFirmware | |
| CapUpdateStatistics | |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | |
| CommonProperties | |
| Compatibility | (Inherited from PosDevice) |
| CurrencyCashList |
Gets a list of cash units supported in the cash changer for the currency represented by the CurrencyCode property. (Inherited from CashChanger) |
| CurrencyCode |
Gets or sets the active currency code to be used by cash changer operations. (Inherited from CashChanger) |
| CurrencyCodeList |
Gets a list of ASCII 3-character ISO 4217 currency codes, separated by commas. (Inherited from CashChanger) |
| CurrentExit |
Gets or sets a value that indicates the current cash-dispensing exit. (Inherited from CashChanger) |
| CurrentService |
Gets or sets the current service. (Inherited from CashChanger) |
| DataCount | |
| DataEventEnabled | |
| DepositAmount |
Gets the total amount of cash accepted. (Inherited from CashChanger) |
| DepositCashList |
Gets the cash units supported in the cash changer for the currency represented by the CurrencyCode property. (Inherited from CashChanger) |
| DepositCodeList |
Gets a list of the currency code indicators for the cash accepted. (Inherited from CashChanger) |
| DepositCounts |
Gets the total of the cash accepted by the cash units. (Inherited from CashChanger) |
| DepositStatus |
Gets the current status of the cash acceptance operation. (Inherited from CashChanger) |
| DeviceDescription | |
| DeviceEnabled | |
| DeviceExits |
Gets the number of exits for dispensing cash. (Inherited from CashChanger) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DeviceStatus |
Gets the current status of the cash changer. (Inherited from CashChanger) |
| ExitCashList |
Gets the cash units that can be dispensed to the exit denoted by the CurrentExit property. (Inherited from CashChanger) |
| ExternallyClaimed | |
| FreezeEvents | |
| FullStatus |
Gets the current full status of the cash slots. (Inherited from CashChanger) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Gets a Boolean value that indicated whether the Cash Changer is an exclusive-use device. (Inherited from CashChanger) |
| PowerNotify | |
| PowerState | |
| RealTimeDataEnabled | (Inherited from CashChanger) |
| ServiceCount | (Inherited from CashChanger) |
| ServiceIndex | (Inherited from CashChanger) |
| ServiceObjectDescription | |
| ServiceObjectVersion | |
| State | |
| 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. (Inherited from CashChanger) |
| BeginDeposit() |
Starts a cash acceptance operation. (Inherited from CashChanger) |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | |
| ClearInput() | |
| ClearInputImpl() | |
| Close() | |
| 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) | |
| CreateStatistic(String, Boolean) | |
| 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. (Inherited from CashChanger) |
| DispenseChange(Int32) |
Dispenses the specified amount of cash. (Inherited from CashChanger) |
| Dispose() | |
| Dispose(Boolean) | |
| EndDeposit(CashDepositAction) |
Completes a cash acceptance operation. (Inherited from CashChanger) |
| FixDeposit() |
Updates property values to reflect the current values in the device. (Inherited from CashChanger) |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | |
| IncrementStatistic(String, Int32) | |
| IncrementStatistic(String) | |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() | |
| PauseDeposit(CashDepositPause) |
Suspends or resumes depositing cash. (Inherited from CashChanger) |
| PreFireEvent(DataEventArgs) | |
| PreFireEvent(DirectIOEventArgs) | |
| PreFireEvent(StatusUpdateEventArgs) | |
| QueueEvent(DataEventArgs) | |
| QueueEvent(DirectIOEventArgs) | |
| QueueEvent(StatusUpdateEventArgs) | |
| QueueEventAndWait(DirectIOEventArgs) | |
| ReadCashCounts() |
Reads the current cash counts. (Inherited from CashChanger) |
| Release() | |
| ResetStatistic(String) | |
| ResetStatistics() | |
| ResetStatistics(StatisticCategories) | |
| ResetStatistics(String[]) | |
| RetrieveStatistic(String) | |
| RetrieveStatistics() | |
| RetrieveStatistics(StatisticCategories) | |
| RetrieveStatistics(String[]) | |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | |
| SetStatisticValue(String, Object) | |
| 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) | |
| UpdateStatistics(Statistic[]) | |
| UpdateStatistics(StatisticCategories, Object) | |
| VerifyState(Boolean, Boolean) | |
Events
| DataEvent | |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | |
| StateChangedEvent | |
| StatusUpdateEvent | |