Description This command is used to retrieve the capabilities of the cash dispenser.
Input Param None.
Output Param LPWFSCDMCAPS lpCaps;
typedef struct _wfs_cdm_caps
{
WORD wClass;
WORD fwType;
WORD wMaxBills;
WORD wMaxCoins;
BOOL bCompound;
BOOL bShutter;
BOOL bRetract;
BOOL bSafeDoor;
BOOL bCoins;
BOOL bCylinders;
BOOL bCashBox;
BOOL bCashIn;
BOOL bRefill;
BOOL bAutoDeposit;
BOOL bVandalCheck;
BOOL bIntermediateStacker;
BOOL bBillsTakenSensor;
WORD fwOutputPositions;
LPSTR lpszExtra;
} WFSCDMCAPS, * LPWFSCDMCAPS;
wClass
Specifies the logical service class. Value is:
WFS_SERVICE_CLASS_CDM
fwType
Specifies the type of the physical device driven by the logical service. Values are:
Value Meaning
WFS_CDM_TYPEATSAFE Device is an Automated Teller Safe.
WFS_CDM_TYPEATMACHINE Device is an Automated Teller Machine.
wMaxBills
Specifies the maximum number of bills or documents that can be dispensed by a single dispensing command; normally reflects hardware limitations of the device. If wMaxBills is 0 then no limit applies to the number of bills to be dispensed in a single dispense command. If the number of bills to be dispensed exceeds the hardware limitations of the device, this will be implemented by the Service Provider by multiple dispenses.
wMaxCoins
Specifies the maximum number of coins that can be dispensed by a single dispensing command; normally reflects hardware limitations of the device.
bCompound
Specifies whether the logical device is part of a compound physical device and is either TRUE or FALSE.
bShutter
Specifies whether the cash dispenser transport mechanism includes a shutter which normally is controlled by the dispensE or PRESENT command, but can be explicitly opened using WFS_CMD_CDM_OPEN_SHUTTER and closed using WFS_CMD_CDM_CLOSE_SHUTTER. Value is either TRUE or FALSE.
bRetract
Specifies whether the cash dispenser transport mechanism has the ability to retract presented bills. Value is either TRUE or FALSE. If no separate retract cash unit is present in the physical device, then retracts are retracted to the reject cash unit.
bSafedoor
Specifies whether the safe door has an electrical time lock, controlled by the WFS_CMD_CDM_OPEN_SAFE_DOOR command. Value is either TRUE or FALSE.
bCoins
Specifies whether the cash dispenser device includes a coin dispensing facility. Value is either TRUE or FALSE.
bCylinders
Specifies whether the coin dispenser device allows for number of coins per cylinder as input, or whether only totals are allowed. Value is either TRUE or FALSE.
bCashBox
Specifies whether the service provides the ability to count for a cashbox assigned to each teller. Value is either TRUE or FALSE. This field is always FALSE if the fwType is WFS_CDM_TYPEATMACHINE.
bCashIn
Specifies whether the service provides the ability to accumulate a cash in amount per currency assigned to each teller. Value is either TRUE or FALSE.
bRefill
Specifies that the device is equipped with cassettes that can be refilled during runtime by just dropping a bundle of bills on top of the stack. Normally, the device cannot detect and count the number of bills in the cassettes. Value is either TRUE or FALSE.
bAutoDeposit
Specifies whether the cash in device is able to deposit money and to provide the denomination as result. Value is either TRUE or FALSE.
bVandalCheck
Specifies whether the physical device includes a feature to check for vandalism. Value is either TRUE or FALSE.
bIntermediateStacker
Specifies whether or not the cash dispenser device supports stacking bills to an intermediate position before the bills are presented to the exit position. Value is either TRUE or FALSE. TRUE means the capability exists and the DISPENSE command can optionally stack bills using the input parameter bPresent=FALSE. Following this DISPENSE, a PRESENT command or REJECT command may be issued. FALSE means the DISPENSE command with a bPresent parameter of FALSE will be rejected with WFS_ERR_UNSUPP_COMMAND.
bBillsTakenSensor
Specifies whether or not the cash dispenser has the ability to detect when bills delivered to the exit position are taken by the user. TRUE means a sensor exists and the “bills taken” condition can be detected.
fwOutputPositions
Specifies which output positions are available on the physical device as a combination of the following flags:
Value Meaning
WFS_CDM_POSLEFT Device has a left output position.
WFS_CDM_POSRIGHT Device has a right output position.
WFS_CDM_POSCENTER Device has a center output position.
lpszExtra
Pointer to a list of vendor-specific, or any other extended information. The information is returned as a series of “key=value” strings so that it is easily extensible by service providers. Each string is null-terminated, with the final string terminating with two null characters.
Error Codes There are no additional error codes generated by this command.
Comments Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.