Description This command is used to get information about the status and contents of the logical and physical cash units used in the dispenser module.
Each logical bill or coin type cash unit can comprise one or more physical cash units. For all other types of cash unit there is a one to one relationship between physical and logical cash unit.
Information on logical cash units is used by the application to process transactions while the information on physical cash units is used during replenishment and maintenance operations.
All counters returned by this command are software counters and therefore might not represent the actual physical cash counts.
Input Param None.
Output Param LPWFSCDMCUINFO lpCashUnitInfo;
typedef struct _wfs_cdm_cu_info
{
USHORT usTellerID;
USHORT usCount;
LPWFSCDMCASHUNIT * lppList;
} WFSCDMCUINFO, * LPWFSCDMCUINFO;
usTellerID
This field is not used in this command and is always NULL. In other commands that use this structure, and that relate to individual tellers (i.e., WFS_CMD_CDM_SET_CASH_UNIT_INFO, WFS_CMD_CDM_START_EXCHANGE, WFS_CMD_CDM_END_EXCHANGE), this field contains the appropriate teller ID value.
usCount
Specifies the number of cash unit structures returned.
lppList
Pointer to an array of pointers to cash unit structures:
typedef struct _wfs_cdm_cashunit
{
USHORT usNumber;
USHORT usType;
CHAR cUnitID[5];
CHAR cCurrencyID[3];
ULONG ulValues;
ULONG ulInitialCount;
ULONG ulCount;
ULONG ulMinimum;
ULONG ulMaximum;
BOOL bAppLock;
BOOL bDevLock;
USHORT usStatus;
LPSTR lpPhysicalPositionName;
USHORT usNumPhysicalCUs;
LPWFSCDMPHCU * lppPhysical;
} WFSCDMCASHUNIT, * LPWFSCDMCASHUNIT;
usNumber
Logical number of cash unit. Each structure has a unique logical number starting with a value of one (1) for the first structure, and incrementing by one for each subsequent structure.
usType
Type of cash unit. Possible values are:
Value Meaning
WFS_CDM_TYPENA Not applicable; typically means cash unit is missing.
WFS_CDM_TYPEREJECTCASSETTE Reject cassette of the cash dispenser.
WFS_CDM_TYPEBILLCASSETTE Bill cassette of the cash dispenser.
WFS_CDM_TYPECOINCYLINDER Cylinder of the coin dispenser.
WFS_CDM_TYPECOINDISPENSER Coin dispenser as a whole unit.
WFS_CDM_TYPERETRACTCASSETTE Retract cassette of the cash dispenser.
WFS_CDM_TYPECOUPON Cassette for coupons or advertising material.
WFS_CDM_TYPEDOCUMENT Cassette for documents.
cUnitID
Cash unit ID. This field provides information identifying a cash unit.
cCurrencyID
Currency ID (ISO format). Three blanks for a reject or a retract cassette which stores more than one currency type and for coupon cassettes which do not contain currencies.
ulValues
Values of coins/bills. This is the value of a single coin or bill in the cash unit, not the total value of the coins or bills present. (Amount expressed in minimum dispense units; see WFS_INF_CDM_CURRENCY_EXP.) Zero for a reject or a retract cassette and for coupon cassettes which do not contain valuable documents.
ulInitialCount
Initial number of coins/bills. This value is persistent; i.e, maintained through power failures, opens, closes and system resets. It is set by the WFS_CMD_CDM_END_EXCHANGE and the WFS_CMD_CDM_SET_CASH_UNIT_INFO commands.
ulCount
Actual count of coins/bills. This value is persistent; i.e, maintained through power failures, opens, closes and system resets. It is set by the WFS_CMD_CDM_END_EXCHANGE and the WFS_CMD_CDM_SET_CASH_UNIT_INFO commands, and is adjusted each time coins/bills are moved from or to the cash unit by a WFSExecute command. Note that for a reject cassette, this value is unreliable, since the typical reason for dumping bills to the reject cassette is a suspected count failure. For a retract cassette this value specifies the number of retracts.
ulMinimum
Specifies the minimum number of bills in a cash unit. If the number falls short of this value a threshold event (WFS_USRE_CDM_CASHUNITTHRESHOLD) is created. For retract and reject cassettes this value equals zero.
ulMaximum
Specifies the maximum number of bills in a cash unit. This value is needed for cash units that are refilled during a cash in operation, reject and retract cassettes. For all other cash units it equals zero. If the number exceeds this value a threshold event (WFS_USRE_CDM_CASHUNITTHRESHOLD) is created.
bAppLock
Application lock status of the logical cash unit. If set to TRUE, the cash unit is locked by the application and cannot be used until unlocked. Application locks can only be applied to bill cassettes and coin cylinders.
bDevLock
Device lock status of the logical cash unit. If set to TRUE, the cash unit is locked by the device and cannot be used until unlocked. Device locks can only be applied to bill cassettes and coin cylinders. Support for device locks is vendor-dependent.
usStatus
Describes the status of the logical cash unit. Available values are:
Value Meaning
WFS_CDM_STATCUOK The cash unit is in a good state.
WFS_CDM_STATCUFULL The reject or retract cassette is full.
WFS_CDM_STATCUHIGH The reject or retract cassette is almost full (threshold).
WFS_CDM_STATCULOW The cassette or coin cylinder is almost empty (threshold).
WFS_CDM_STATCUEMPTY The cassette or coin cylinder is empty.
WFS_CDM_STATCUINOP The cassette or coin cylinder is inoperative.
WFS_CDM_STATCUMISSING The cassette, reject or retract cassette is missing.
WFS_CDM_STATCUNOVAL The values of the specified cash unit are not available. This can be the case when the cassette is changed without using the operator functions.
WFS_CDM_STATCUNOREF There is no reference value available for the notes in this cassette.
lpPhysicalPositionName
This field points to a name (e.g. “hopper 1”) indicating the physical location in the dispenser device in which this cash unit is installed. This field is only used when the logical cash unit refers to one physical cash unit.
usNumPhysicalCUs
This value indicates the number of physical cash unit structures returned. If this field is zero then the logical cash unit structure above relates directly to a physical cash unit.
lppPhysical
Pointer to an array of pointers to physical cash unit structures:
typedef struct _wfs_cdm_physicalcu
{
LPSTR lpPhysicalPositionName;
CHAR cUnitID[5];
ULONG ulCount;
USHORT usPStatus;
} WFSCDMPHCU, * LPWFSCDMPHCU;
lpPhysicalPositionName
This field points to a name (e.g. “hopper 1”) indicating the physical location in the dispenser device in which this cash unit is installed.
cUnitID
Cash unit ID. This field provides information identifying a physical cassette clearly.
ulCount
Actual count of coins/bills in the physical cash unit.
usPStatus
Describes the status of the physical cash unit. Same values as usStatus.
Error Codes There are no additional error codes generated by this command.
Comments None.