Description This command is used to retrieve details of the definition of a single or all fields on a specified form.
Input Param LPWFSTTUQUERYFIELD lpQueryField;
typedef struct _wfs_ttu_query_field
{
LPSTR lpszFormName;
LPSTR lpszFieldName;
} WFSTTUQUERYFIELD, * LPWFSTTUQUERYFIELD;
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 LPWFSTTUFRMFIELD * lppFields;
lppFields
Pointer to a null-terminated array of pointers to field definition structures:
typedef struct _wfs_ttu_frm_field
{
LPSTR lpszFieldName;
WORD fwType;
WORD fwClass;
WORD fwAccess;
WORD fwOverflow;
LPSTR lpszFormat;
} WFSTTUFRMFIELD, * LPWFSTTUFRMFIELD;
lpszFieldName
Pointer to the null-terminated field name.
fwType
Specifies the type of field and can be one of the following:
Value Meaning
WFS_TTU_FIELDTEXT A text field.
WFS_TTU_FIELDINVISIBLE An invisible text field.
WFS_TTU_FIELDPASSWORD A password field, input is echoed as ‘*’.
fwClass
Specifies the class of the field and can be one of the following:
Value Meaning
WFS_TTU_CLASSSTATIC The field data cannot be set by the application.
WFS_TTU_CLASSOPTIONAL The field data can be set by the application.
WFS_TTU_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_TTU_ACCESSREAD The field is used for input from the physical device.
WFS_TTU_ACCESSWRITE The field is used for output to the physical device.
fwOverflow
Specifies how an overflow of field data should be handled and can be one of the following:
Value Meaning
WFS_TTU_OVFTERMINATE Return an error and terminate display of the form.
WFS_TTU_OVFTRUNCATE Truncate the field data to fit in the field.
WFS_TTU_OVFOVERWRITE Print the field data beyond the extents of the field boundary.
Error Codes The following additional error codes can be generated by this command:
Value Meaning
WFS_ERR_TTU_FORMNOTFOUND The specified form cannot be found.
WFS_ERR_TTU_FORMINVALID The specified form is invalid.
WFS_ERR_TTU_FIELDNOTFOUND The specified field cannot be found.
WFS_ERR_TTU_FIELDINVALID The specified field is invalid.
Comments None.