Description This command is used to retrieve details of the definition of a single or all fields on a specified form.
Input Param LPWFSPTRQUERYFIELD lpQueryField;
typedef struct _wfs_ptr_query_field
{
LPSTR lpszFormName;
LPSTR lpszFieldName;
} WFSPTRQUERYFIELD, * LPWFSPTRQUERYFIELD;
lpszFormName
Pointer to the null-terminated form name.
lpszFieldName
Pointer 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 * lppFields;
lppFields
Pointer to a null-terminated array of pointers to field definition structures:
typedef struct _wfs_frm_field
{
LPSTR lpszFieldName;
WORD wIndexCount;
WORD fwType;
WORD fwClass;
WORD fwAccess;
WORD fwOverflow;
LPSTR lpszInitialValue;
LPSTR lpszFormat;
} WFSFRMFIELD, * LPWFSFRMFIELD;
lpszFieldName
Pointer to the null-terminated field name.
wIndexCount
Specifies the number of entries for an index field. A value of zero indicates that this field is not an index field. Index fields are typically used to present information in a tabular fashion.
fwType
Specifies the type of field and can be one of the following:
Value Meaning
WFS_FRM_FIELDTEXT A text field.
WFS_FRM_FIELDMICR A Magnetic Ink Character Recognition field.
WFS_FRM_FIELDOCR An Optical Character Recognition field.
WFS_FRM_FIELDMSF A Magnetic Stripe Facility field.
WFS_FRM_FIELDBARCODE A Barcode field.
WFS_FRM_FIELDGRAPHIC A Graphic field
WFS_FRM_FIELDPAGEMARK A Page Mark field
fwClass
Specifies the class of the field and can be one of the following:
Value Meaning
WFS_FRM_CLASSSTATIC The field data cannot be set by the application.
WFS_FRM_CLASSOPTIONAL The field data can be set by the application.
WFS_FRM_CLASSREQUIRED The field data must be set by the application.
fwAccess
Specifies whether the field is to be used for input, output, or both and can be a combination of the following bit-flags:
Value Meaning
WFS_FRM_ACCESSREAD The field is used for input.
WFS_FRM_ACCESSWRITE The field is used for ouput.
fwOverflow
Specifies how an overflow of field data should be handled and can be one of the following:
Value Meaning
WFS_FRM_OVFTERMINATE Return an error and terminate printing of the form.
WFS_FRM_OVFTRUNCATE Truncate the field data to fit in the field.
WFS_FRM_OVFBESTFIT Fit the text in the field.
WFS_FRM_OVFOVERWRITE Print the field data beyond the extents of the field boundary.
WFS_FRM_OVFWORDWRAP If the field can hold more than one line the text is wrapped around.
lpszInitialValue
The initial value of the field. When the form is printed (using WFS_CMD_PTR_PRINT_FORM), this value will be used if another value is not provided.
lpszFormat
Format string as defined in the form for this field.
Error Codes The following additional error codes can be generated by this command:
Value Meaning
WFS_ERR_PTR_FORMNOTFOUND The specified form cannot be found.
WFS_ERR_PTR_FORMINVALID The specified form is invalid.
WFS_ERR_PTR_FIELDNOTFOUND The specified field cannot be found.
WFS_ERR_PTR_FIELDINVALID The specified field is invalid.
Comments None.