CoinDispenser Members

  • Article

2/27/2008

Defines the programmatic interface for a UPOS Coin Dispenserdevice.

The following tables list the members exposed by the CoinDispenser type.

Protected Constructors

  Name Description
CoinDispenser Creates an instance of the CoinDispenser class.

Top

Public Fields

  Name Description
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).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)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif ExtendedErrorStatistics  Indicates a specified statistic could not be reset or updated. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif ExtendedErrorStatisticsDependency  (inherited from PosCommon )
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticCommunicationErrorCount  Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticDeviceCategory  Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticFirmwareRevision  Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticHoursPoweredCount  Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticInstallationDate  Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticInterface  Holds the programmatic name of the Interface common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticManufactureDate  Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticManufacturerName  Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticMechanicalRevision  Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticModelName  Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticSerialNumber  Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatisticUnifiedPOSVersion  Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusEmpty Indicates the Coin Dispenser device cannot dispense coins because it is empty.
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusJam Indicates a mechanical fault has occurred in the Coin Dispenser device.
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusNearEmpty Indicates the Coin Dispenser device can still dispense coins, but the device is almost empty.
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusOk Indicates the Coin Dispenser device is ready to dispense coins, or the device is unable to detect an error condition.
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusPowerOff  Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusPowerOffline  Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusPowerOffOffline  Indicates that either the device’s power is off or it is offline. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusPowerOnline  Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareComplete  Indicates the update firmware process has completed successfully. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif 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)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif 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)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceOk  Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceUnknown  Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceUnrecoverable  Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareProgress  Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon)
ms884014.pubfield(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif 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
ms884014.pubproperty(en-us,WinEmbedded.1002).gif 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)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapEmptySensor Gets the Boolean value that indicates whether the device can support an out-of-coins condition.
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapJamSensor Gets the Boolean value that indicates whether the Coin Dispenser device can report a mechanical jam or failure condition.
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapNearEmptySensor Gets the Boolean value that indicates whether the Coin Dispenser device can report when it is almost out of coins.
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapPowerReporting  Gets the power reporting capabilities of the device. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapStatisticsReporting  Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CapUpdateFirmware  Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif 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)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif CheckHealthText  Gets a string that indicates the health of the device. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif Claimed  Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif Compatibility  Gets the compatibility level of a device. (inherited from PosDevice)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif DeviceDescription  Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif DeviceEnabled  Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif DeviceName  Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif DispenserStatus Gets the current status of the dispenser.
ms884014.pubproperty(en-us,WinEmbedded.1002).gif FreezeEvents  Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif PowerNotify  Gets or sets the type of power notification selection made by the application. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif PowerState  Gets the current power condition. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif ServiceObjectDescription  Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif ServiceObjectVersion  Gets the Service Object version number. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif State  Gets the current state of the device. (inherited from PosCommon)
ms884014.pubproperty(en-us,WinEmbedded.1002).gif 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
ms884014.protproperty(en-us,WinEmbedded.1002).gif DeviceInstanceId  (inherited from PosCommon )
ms884014.protproperty(en-us,WinEmbedded.1002).gif DevicePath  Gets or sets the hardware path of a device. (inherited from PosCommon)
ms884014.protproperty(en-us,WinEmbedded.1002).gif HardwareId  (inherited from PosCommon )
ms884014.protproperty(en-us,WinEmbedded.1002).gif IsExclusiveUseDevice Overridden. Gets the Boolean value that indicates whether the Coin Dispenser device is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

  Name Description
ms884014.pubmethod(en-us,WinEmbedded.1002).gif AdjustCashCounts Sets initial amounts in the Coin Dispenser after initial setup or adjusts cash counts after replenishment or removal.
ms884014.pubmethod(en-us,WinEmbedded.1002).gif CheckHealth  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif Claim  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif Close  Releases the device and its resources. (inherited from PosCommon)
ms884014.pubmethod(en-us,WinEmbedded.1002).gif CompareFirmwareVersion  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif DirectIO  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif DispenseChange Indicates a count of the coins it dispenses.
ms884014.pubmethod(en-us,WinEmbedded.1002).gif Equals  Overloaded. (inherited from Object )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif GetHashCode  (inherited from Object )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif GetType  (inherited from Object )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif Open  Opens a device for later input/output processing. (inherited from PosCommon)
ms884014.pubmethod(en-us,WinEmbedded.1002).gif ReadCashCounts Reads the currency totals contained in the device.
ms884014.pubmethod(en-us,WinEmbedded.1002).gif ms884014.static(en-us,WinEmbedded.1002).gif ReferenceEquals  (inherited from Object )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif Release  Releases exclusive access to the device. (inherited from PosCommon)
ms884014.pubmethod(en-us,WinEmbedded.1002).gif ResetStatistic  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif ResetStatistics  Overloaded. (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif RetrieveStatistic  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif RetrieveStatistics  Overloaded. (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif ToString  (inherited from Object )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif UpdateFirmware  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif UpdateStatistic  (inherited from PosCommon )
ms884014.pubmethod(en-us,WinEmbedded.1002).gif UpdateStatistics  Overloaded. (inherited from PosCommon )

Top

Protected Methods

  Name Description
ms884014.protmethod(en-us,WinEmbedded.1002).gif DeleteConfigurationProperty  (inherited from PosCommon )
ms884014.protmethod(en-us,WinEmbedded.1002).gif Finalize  (inherited from Object )
ms884014.protmethod(en-us,WinEmbedded.1002).gif GetConfigurationProperty  (inherited from PosCommon )
ms884014.protmethod(en-us,WinEmbedded.1002).gif Invoke  (inherited from PosCommon )
ms884014.protmethod(en-us,WinEmbedded.1002).gif MemberwiseClone  (inherited from Object )
ms884014.protmethod(en-us,WinEmbedded.1002).gif SetConfigurationProperty  (inherited from PosCommon )

Top

Public Events

(see also Protected Events )

  Name Description
ms884014.pubevent(en-us,WinEmbedded.1002).gif DirectIOEvent  Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon)
ms884014.pubevent(en-us,WinEmbedded.1002).gif StatusUpdateEvent  Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon)

Top

Protected Events

  Name Description
ms884014.protevent(en-us,WinEmbedded.1002).gif DeviceAddedEvent  (inherited from PosCommon )
ms884014.protevent(en-us,WinEmbedded.1002).gif DeviceRemovedEvent  (inherited from PosCommon )

Top

See Also

Reference

CoinDispenser Class
Microsoft.PointOfService Namespace