Description This command reports the full range of information available, including the information that is provided by the service provider.
Input Param None.
Output Param LPWFSDEPSTATUS lpStatus;
typedef struct _wfs_dep_status
{
WORD fwDevice;
WORD fwDepContainer;
WORD fwDepTransport;
WORD fwEnvSupply;
WORD fwEnvDispenser;
WORD fwPrinter;
WORD fwToner;
WORD fwShutter;
WORD wNumOfDeposits;
LPSTR lpszExtra;
} WFSDEPSTATUS, * LPWFSDEPSTATUS;
fwDevice
Specifies the state of the Depository device as one of the following flags:
Value Meaning
WFS_DEP_DEVONLINE The device is on-line. The device is present and operational (i.e. not busy processing a request and does not have a hardware error).
WFS_DEP_DEVOFFLINE The device is off-line. The device is present and powered on but it is not operational (e.g. a switch may have been used to change it to an off-line state).
WFS_DEP_DEVPOWEROFF The device is powered off. The device is present, but is currently powered off.
WFS_DEP_DEVBUSY The device is busy processing a request. The device is present and an EXECUTE request is currently being processed.
WFS_DEP_DEVNODEVICE There is no device connected.
WFS_DEP_DEVHWERROR The device is inoperable due to a hardware error. The device is present but a hardware fault prevents it from being used.
WFS_DEP_DEVUSERERROR The device is present but a person is preventing proper operation. The application should suspend the device operation or remove the device from service until the service provider generates a device state change event indicating the condition of the device has changed i.e. the error is removed (WFS_DEP_DEVONLINE) or a permanent error condition has occurred (WFS_DEP_DEVHWERROR).
fwDepContainer
Specifies the state of the deposit container that contains the deposited envelopes or bags as one of the following flags:
Value Meaning
WFS_DEP_DEPOK The deposit container is in a good state.
WFS_DEP_DEPHIGH The deposit container is almost full (threshold).
WFS_DEP_DEPFULL The deposit container is full.
WFS_DEP_DEPINOP The deposit container is inoperable.
WFS_DEP_DEPMISSING The deposit container is missing.
fwDepTransport
Specifies the state of the deposit transport mechanism that transports the envelope into the deposit container. Specified as one of the following flags:
Value Meaning
WFS_DEP_DEPOK The deposit transport is in a good state.
WFS_DEP_DEPINOP The deposit transport is inoperative due to a hardware failure or media jam.
WFS_DEP_DEPUNKNOWN Due to a hardware error or other condition, the state of the deposit transport cannot be determined.
WFS_DEP_DEPNOTSUPP The physical device has no deposit transport.
fwEnvSupply
Specifies the state of the envelope supply unit as one of the following flags:
Value Meaning
WFS_DEP_ENVOK The envelope supply unit is in a good state (and locked).
WFS_DEP_ENVLOW The envelope supply unit is present but low.
WFS_DEP_ENVEMPTY The envelope supply unit is present but empty. No envelopes can be dispensed.
WFS_DEP_ENVINOP The envelope supply unit is in an inoperable state. No envelopes can be dispensed.
WFS_DEP_ENVMISSING The envelope supply unit is missing.
WFS_DEP_ENVUNLOCKED The envelope supply unit is unlocked
fwEnvDispenser
Specifies the state of the envelope dispenser. Specified as one of the following flags.
Value Meaning
WFS_DEP_ENVOK The envelope dispenser is present and in a good state.
WFS_DEP_ENVINOP The envelope dispenser is present but in an inoperable state. No envelopes can be dispensed.
WFS_DEP_ENVUNKNOWN Due to a hardware error or other condition, the state of the envelope dispenser cannot be determined.
WFS_DEP_ENVNOTSUPP The physical device has no envelope dispenser.
fwPrinter
Specifies the state of the printer. Specified as one of the following flags:
Value Meaning
WFS_DEP_PTROK The printer is present and in a good state.
WFS_DEP_PTRINOP The printer is inoperative.
WFS_DEP_PTRUNKNOWN Due to a hardware error or other condition, the state of the printer cannot be determined.
WFS_DEP_PTRNOTSUPP The physical device has no printer.
fwToner
Specifies the state of the toner (or ink) for the printer. Specified as one of the following flags:
Value Meaning
WFS_DEP_TONOK The toner cassette is full.
WFS_DEP_TONLOW The toner in the printer is low.
WFS_DEP_TONEMPTY The toner in the printer is empty.
WFS_DEP_TONUNKNOWN Due to a hardware error or other condition, the state of the toner for the printer cannot be determined.
WFS_DEP_TONNOTSUPP The physical device has no toner.
fwShutter
Specifies the state of the shutter or door. Specified as one of the following flags:
Value Meaning
WFS_DEP_SHTCLOSED The shutter is closed.
WFS_DEP_SHTOPEN The shutter is opened.
WFS_DEP_SHTJAMMED The shutter is jammed.
WFS_DEP_SHTUNKNOWN Due to a hardware error or other condition, the state of the shutter cannot be determined.
WFS_DEP_SHTNOTSUPP The physical device has no shutter.
wNumOfDeposits
Specifies the number of envelopes or bags in the deposit container. This value is persistent, i.e. maintained through power failures, opens, closes and system resets.
lpszExtra
Specifies 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.