Description This command is used to request the status of the devices attached to a CDM, such as the safedoor and other devices, or to retrieve device-specific information.
Input Param None.
Output Param LPWFSCDMSTATUS lpStatus;
typedef struct _wfs_cdm_status
{
WORD fwDevice;
WORD fwSafeDoor;
WORD fwDispenser; WORD fwIntermediateStacker; LPWFSCDMOUTPOS * lppOutputPositions; LPSTR lpszExtra;
} WFSCDMSTATUS, * LPWFSCDMSTATUS;
fwDevice
Specifies the state of the cash dispenser device as one of the following flags:
Value Meaning
WFS_CDM_DEVONLINE The device is online. This is returned when the dispenser is present and operational. The fwDispenser field should be checked to determine the state of the cash units; if the state is WFS_CDM_DISPCUSTOP, no bills can be dispensed. The fwSafeDoor field can be checked to determine the state of the safe door, but note that the effect of the door state on the ability to dispense cash depends on the implementation of the specific service.
WFS_CDM_DEVOFFLINE The device is present and powered on, but is offline.
WFS_CDM_DEVPOWEROFF The device is present but is powered off.
WFS_CDM_DEVBUSY The device is busy processing a WFS[Async]Execute or WFS[Async]GetInfo request.
WFS_CDM_DEVNODEVICE There is no device connected.
WFS_CDM_DEVUSERERROR The device is present but a person is preventing proper device operation. The application should suspend the device from service until the service provider generates a device state change event indicating the condition of the device has changed, e.g., the error is removed (WFS_CDM_DEVONLINE) or a permanent error condition has occurred (WFS_CDM_DEVHWERROR).
WFS_CDM_DEVHWERROR The device is present and powered on, but is inoperable due to a hardware error. The device stays in this condition until the hardware error is cleared.
fwSafeDoor
Specifies the state of the safe door as one of the following flags:
Value Meaning
WFS_CDM_DOORNOTSUPPORTED Physical device has no safe door or door state reporting is not supported.
WFS_CDM_DOOROPEN Safe door is open.
WFS_CDM_DOORCLOSED Safe door is closed but not locked.
WFS_CDM_DOORLOCKED Safe door is closed and locked.
WFS_CDM_DOORUNKNOWN Due to a hardware error or other condition, the state of the door cannot be determined.
fwDispenser
Specifies the state of the dispenser cash units as one of the following flags:
Value Meaning
WFS_CDM_DISPOK All logical cash units present are in a good state.
WFS_CDM_DISPCUSTATE One of the logical cash units present is in an abnormal state. The dispenser is operational, but one or more of the cash units is in a low, empty or inoperative condition. Bills can still be dispensed from at least one of the cash units.
WFS_CDM_DISPCUSTOP Due to a cash unit failure dispensing is impossible. The dispenser is operational, but no bills can be dispensed because all of the cash units are in an empty or inoperative condition. This state also occurs when a reject cash unit is full or no reject cassette is present.
WFS_CDM_DISPCUUNKNOWN Due to a hardware error or other condition, the state of the cash units cannot be determined.
fwIntermediateStacker
Specifies the state of the intermediate stacker as one of the following flags:
Value Meaning
WFS_CDM_ISEMPTY The intermediate stacker is empty.
WFS_CDM_ISNOTEMPTY The intermediate stacker is not empty.
WFS_CDM_ISUNKNOWN Due to a hardware error or other condition, the state of the intermediate stacker cannot be determined.
WFS_CDM_ISNOTSUPPORTED The physical device has no intermediate stacker.
lppOutputPositions
Pointer to a NULL terminated array of pointers to WFSCDMOUTPOS structures (one for each supported output position):
typedef struct _wfs_cdm_outpos
{
WORD fwPosition;
WORD fwShutter;
WORD fwOutputPosition;
WORD fwTransport;
} WFSCDMOUTPOS, * LPWFSCDMOUTPOS;
fwPosition
Specifies the output position as one of the following flags:
Value Meaning
WFS_CDM_POSLEFT left output position.
WFS_CDM_POSRIGHT right output position.
WFS_CDM_POSCENTER center output position.
fwShutter
Specifies the state of the shutter as one of the following flags:
Value Meaning
WFS_CDM_SHTCLOSED The shutter is closed.
WFS_CDM_SHTOPEN The shutter is opened.
WFS_CDM_SHTJAMMED The shutter is jammed.
WFS_CDM_SHTUNKNOWN Due to a hardware error or other condition, the state of the shutter cannot be determined.
WFS_CDM_SHTNOTSUPPORTED The physical device has no shutter or shutter state reporting is not supported.
fwOutputPosition
Specifies the state of the cash tray as one of the following flags:
Value Meaning
WFS_CDM_CTEMPTY The cash tray is empty.
WFS_CDM_CTNOTEMPTY The cash tray is not empty.
WFS_CDM_CTUNKNOWN Due to a hardware error or other condition, the state of the cash tray cannot be determined.
WFS_CDM_CTNOTSUPPORTED The physical device has no cash tray or cash tray state reporting is not supported.
fwTransport
Specifies the state of the transport mechanism as one of the following flags:
Value Meaning
WFS_CDM_TPOK The transport is in a good state.
WFS_CDM_TPINOP The transport is inoperative due to a hardware failure or media jam.
WFS_CDM_TPUNKNOWN Due to a hardware error or other condition, the state of the transport cannot be determined.
WFS_CDM_TPNOTSUPPORTED The physical device has no transport or transport state reporting is not supported.
lpszExtra
Points 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 will be 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.