Description This command is used to retrieve the capabilities of the Depository.
Input Param None.
Output Param LPWFSDEPCAPS lpCaps;
typedef struct _wfs_dep_caps
{
WORD wClass;
WORD fwType;
WORD fwEnvSupply;
BOOL bDepTransport;
BOOL bPrinter;
BOOL bToner;
BOOL bShutter;
BOOL bPrintOnRetracts;
BOOL bRetractToDeposit;
WORD wMaxNumChars;
LPSTR lpszExtra;
} WFSDEPCAPS, * LPWFSDEPCAPS;
wClass
Specifies the logical service class, value is:
WFS_SERVICE_CLASS_DEP
fwType
Specifies the type of the depository device as a combination of the following flags:
Value Meaning
WFS_DEP_TYPEENVELOPE Depository accepts envelopes
WFS_DEP_TYPEBAGDROP Depository accepts bags
fwEnvSupply
Defines what type of Envelope Supply Unit exists as one of the following flags:
Value Meaning
WFS_DEP_ENVMOTORIZED Envelope Supply can dispense envelopes
WFS_DEP_ENVMANUAL Envelope Supply is manual and must be unlocked to allow envelopes to be taken. The Service Event, WFS_SRVE_DEP_ENVTAKEN, can not be sent and the Execute Command, WFS_CMD_DEP_RETRACT can not be supported.
WFS_DEP_ENVNONE No Envelope Supply or Envelope Supply is manual and envelopes can be taken at any time. The Service Event, WFS_SRVE_DEP_ENVTAKEN, can not be sent. and the Execute Command, WFS_CMD_DEP_RETRACT can not be supported.
bDepTransport
Specifies whether a deposit transport mechanism is available and is either TRUE or FALSE.
bPrinter
Specifies whether a printer is available and is either TRUE or FALSE.
bToner
Specifies whether the printer has a toner (or ink) cassette and is either TRUE or FALSE.
bShutter
Specifies whether a deposit transport shutter is available and is either TRUE or FALSE.
bPrintOnRetracts
Specifies whether the device can print on retracted envelopes and is either TRUE or FALSE.
bRetractToDeposit
Specifies whether retracted envelopes are put in the deposit container and is either TRUE or FALSE. If TRUE, envelopes are retracted back to the deposit container. If FALSE, envelopes are retracted back to the envelope dispenser.
wMaxNumChars
Specifies the maximum number of characters that can be printed on the envelope.
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.