3.2 WFS_INF_CHK_CAPABILITIES

Description

This function is used to request device capability information.

Input Param

None.

Output Param

LPWFSCHKCAPS
typedef struct _wfs_chk_caps
     {
     WORD     wClass;
     WORD     fwType;
     BOOL     bCompound;
     BOOL     fMICR;
     BOOL     fOCR;
     BOOL     fAutoFeed;
     BOOL     fEndorser;
     BOOL     fEncoder;
     WORD     fwStamp;
     WORD     wImageCapture;
     USHORT   nPockets;
     LPSTR    lpszFontNames;
     LPSTR    lpszEncodeNames;
     LPSTR    lpszExtra;
     }  WFSCHKCAPS, * LPWFSCHKCAPS

fwClass

Specifies the logical service; value is WFS_SERVICE_CLASS_CHK.

fwType

Specifies the type of the physical device; only current value is WFS_CHK_TYPECHK.

bCompound

TRUE if the logical device is part of a compound device.

fMICR

Can read MICR on checks.

fOCR

Can read OCR on checks.

fAutoFeed

Has autofeed capability; if FALSE has only manual feed.

fEndorser

A programmable endorser is present.

fEncoder

An encoder is present.

fwStamp

One of:

WFS_CHK_STAMPNONE
WFS_CHK_STAMPFRONT
WFS_CHK_STAMPREAR
WFS_CHK_STAMPBOTH

wImageCapture

Same values as wStamp

nPockets

Number of pockets; if 0 or 1, device has no pockets.

lpszFontNames

The names of the fonts supported for reading; each is terminated with a NULL and the string is terminated with two NULLs.

lpszEncodeNames

The names of the fonts supported for encoding; each is terminated with a NULL and the string is terminated with two NULLs.

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.

Error Code

There are no additional error codes generated by this command.

Comments

The font names are standardized so that applications can check for standard literals, e.g.: CMC7, E13B. Reserved OCR font names are TBD due to numerous local variants. (i.e. OCRA and OCRB are not enough).

Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.

3.3 WFS_INF_CHK_FORM_LIST

Description

This function is used to retrieve the list of forms available to the service.

Input Param

None.

Output Param

LPSTR          lpszFormList;

lpszFormList

Points to a list of null-terminated form names, with the final name terminating with two null characters.

Error Codes

There are no additional error codes generated by this command.

3.4 WFS_INF_CHK_QUERY_FORM

Description

This function is used to retrieve the details on the definition of a specified form.

Input Param

LPSTR          lpszFormName;

lpszFormName

Specifies the null-terminated name of the form on which to retrieve details.

Output Param

LPWFSFRMHEADER

See section 7.1.4.5 WFS_INF_PTR_QUERY_FORM, for details of this structure.

Error Codes

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

3.5 WFS_INF_CHK_QUERY_FIELD

Description

This function is used to retrieve details on the definition of a single or all fields on a specified form.

Input Param

LPWFSCHKQUERYFIELD, as defined below.

typedef struct _wfs_chk_query_field
     {
     LPSTR                    lpszFormName;
     LPSTR                    lpszFieldName;
     } WFSCHKQUERYFIELD, * LPWFSCHKQUERYFIELD;

lpszFormName

Points to the null-terminated form name.

lpszFieldName

Points to the null-terminated name of the field about which to retrieve details. If this value is NULL, then retrieve details for all fields on the form.

Output Param

LPWFSFRMFIELD          * lpFields;

See Section 7.1.4.7, WFS_PTR_QUERY_FIELD for details of this structure.

Error Codes

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