4.3 WFS_CMD_DEP_RETRACT

Description This command is used to retract an envelope that was not taken by a customer after an envelope dispense operation. The given string is printed on the envelope and the envelope is retracted into the deposit container or back to the envelope dispenser, depending on the capabilities of the physical device.

Input Param LPWFSDEPENVELOPE lpEnvelope;

typedef struct _wfs_dep_envelope
{
LPSTR lpszPrintData;
} WFSDEPENVELOPE, * LPWFSDEPENVELOPE;

lpszPrintData
Specifies the data that will be printed on the envelope that is retracted.

Output Param None.

Error Codes The following additional error codes can be generated by this command:

Value Meaning

WFS_ERR_DEP_DEPFULL The deposit container is full.

WFS_ERR_DEP_DEPJAMMED An envelope jam occurred in the deposit transport.

WFS_ERR_DEP_CONTMISSING The deposit container is not present.

WFS_ERR_DEP_ENVJAMMED An envelope jam occurred

WFS_ERR_DEP_NOENV No envelope to retract.

WFS_ERR_DEP_PTRFAIL The printer failed.

WFS_ERR_DEP_SHTNOTCLOSED The shutter failed to close.

Events There are no additional events generated by this command.

Comments None.