4.2 WFS_CMD_CHK_MULTICOMMAND

Description

This function is used to encode the amount field of the check, optionally stamp and endorse the check, and select a pocket to which the check will be sorted if the device supports these capabilities.

Input Param

LPWFSCHKMULTICOMMAND
typedef struct _wfs_in_multicommand
     {
     WORD      hDoc;     
     DWORD     dwOptions;
     BYTE    . pocket;
     LPSTR     lpszEncodeFormName;
     LPSTR     lpszEncodeFields;
     LPSTR     lpszEndorserFormName;
     LPSTR     lpszEndorserFields;
     LPSTR     lpszExtra;
     } WFSCHKMULTICOMMAND, * LPWFSCHKMULTICOMMAND;

hDoc

handle to the check to be processed; NULL means "current" check.

dwOptions

Command options, as a combination of the following flags:
WFS_CHK_OPTSTAMPFRONT
WFS_CHK_OPTSTAMPBACK
WFS_CHK_OPTENDORSEFRONT
WFS_CHK_OPTENDORSEBACK
WFS_CHK_OPTSORTONLY
WFS_CHK_OPTTAKEIMAGE

pocket

Ignored if no sorter present.

lpszEncodeFormName

Name of form defining encoder fields.

lpszEncodeFields

List of fieldname/value pairs for encoder.

lpszEndorserFormName

Name of form defining endorser fields.

lpszEndorserFields

List of fieldname/value pairs for endorser.

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 is null-terminated, with the final string terminating with two null characters.

Output Param

None.

Error Codes

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

Value	Meaning
WFS_ERR_CHK _FORMNOTFOUND	Invalid form name.
WFS_ERR_CHK _FIELDNOTFOUND	Invalid field name.
WFS_ERR_CHK _REQDFIELDMISSING	A field required by the form is not supplied.
WFS_ERR_CHK _EXTRAFIELD	A field supplied by the application does not exist in this form (warning).
WFS_ERR_CHK _FIXEDOVERWRITE	The application passed a field which is marked as fixed in the form description (warning).
WFS_ERR_CHK _FIELDSPECFAILURE	The syntax of the lpszFields member is invalid.
WFS_ERR_CHK _UNSUPPORTEDCAP	The service does not have a capability requested in this command (i.e. a pocket sort was requested on a device with zero pockets). This is a warning; the requested capability is ignored.

Execute Events

WFS_EXEE_CHK _NOMEDIA	No check has been inserted in the (manual mode) check reader.
WFS_EXEE_CHK _MEDIAINSERTED	A check was inserted; this is only issued following the above event.

Comments

The contents of the lpszFields parameter is as follows:

fieldname=value\0fieldname=value\0.......fieldname=value\0\0

Each fieldname=value pair is terminated with a NULL; the end of the buffer is marked with an additional NULL.

If an extra field is passed to the command verb a warning message will be returned. If a required field is missing an error message is returned and the form is not printed. Missing optional fields don't cause a problem. Overwriting of a fixed field results in an error and the print operation does not occur.

The lpszEncodeFormName parameter should be the same as the form name used previously to read the encode line with WFS_CMD_CHK_READ_FORM. Results are unpredictable if a different form name is used.