CashChanger Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Defines the programmatic interface for a UPOS Cash Changer device.
The following tables list the members exposed by the CashChanger type.
Protected Constructors
| Name | Description | |
|---|---|---|
| CashChanger | Creates an instance of CashChanger class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "ms883725.pubfield(en-US,WinEmbedded.11).gif") .gif "ms883725.static(en-US,WinEmbedded.11).gif") |
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) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms883725.pubproperty(en-US,WinEmbedded.11).gif") |
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 | Gets the compatibility level of a device. (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. |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (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. |
|
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 | Get or sets the Boolean value that indicates whether the DepositAmount and DepositCounts properties are updated in real time. |
|
ServiceCount | Gets the number of integrated services used by the cash changer service. |
|
ServiceIndex | Indicates the service index for each type of the integrated service types. |
|
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) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms883725.protproperty(en-US,WinEmbedded.11).gif") |
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicated whether the Cash Changer is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms883725.pubmethod(en-US,WinEmbedded.11).gif") |
AdjustCashCounts | Sets the initial amount of cash after setup or adjusts cash counts after replenishment or removal. |
|
BeginDeposit | Starts a cash acceptance operation. |
|
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PosCommon ) |
|
ClearInput | Clears all device input that has been buffered. |
|
Close | Releases the device and its resources. (inherited from PosCommon) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
DirectIO | (inherited from PosCommon ) |
|
DispenseCash | Dispenses the specified cash units and cash counts from the device. |
|
DispenseChange | Dispenses the specified amount of cash. |
|
EndDeposit | Completes a cash acceptance operation. |
|
Equals | Overloaded. (inherited from Object ) |
|
FixDeposit | Updates property values to reflect the current values in the device. |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
|
PauseDeposit | Suspends or resumes depositing cash. |
|
ReadCashCounts | Reads the current cash counts. |
|
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms883725.protmethod(en-US,WinEmbedded.11).gif") |
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "ms883725.pubevent(en-US,WinEmbedded.11).gif") |
DataEvent | Raised by the service object to notify the application when the cash changer has a status change. |
|
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) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "ms883725.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top