formfieldbuffer(3X) formfieldbuffer(3X)
NAME
formfieldbuffer - field buffer control
SYNOPSIS
##include <>
int setfieldbuffer(FIELD *field, int buf, const char *value);
char *fieldbuffer(const FIELD *field, int buffer);
int setfieldstatus(FIELD *field, bool status);
bool fieldstatus(const FIELD *field);
int setmaxfield(FIELD *field, int max);
DESCRIPTION
The function setfieldbuffer sets the numbered buffer of the given
field to contain a given string. Buffer 0 is the displayed value of
the field; other numbered buffers may be allocated by applications
through the nbuf argument of (see formfieldnew(3X)) but are not
manipulated by the forms library. The function fieldbuffer returns
the address of the buffer. Please note that this buffer has always the
length of the buffer, that means that it may typically contain trailing
spaces. If you entered leading spaces the buffer may also contain them.
If you want the raw data, you must write your own routine that copies
the value out of the buffer and removes the leading and trailing spa-
ces. Please note also, that subsequent operations on the form will
probably change the content of the buffer. So don't use it for long
term storage of the entered form data.
The function setfieldstatus sets the associated status flag of field;
fieldstatus gets the current value. The status flag is set to a
nonzero value whenever the field changes.
The function setmaxfield sets the maximum size for a dynamic field.
An argument of 0 turns off any maximum size threshold for that field.
RETURN VALUE
The fieldbuffer function returns NUL on error.
The fieldstatus function returns TRUE or FALSE.
The remaining routines return one of the following:
EOK The routine succeeded.
ESYSTEMEROR
System error occurred (see errno).
EBADARGUMENT
Routine detected an incorrect or out-of-range argument.
SEE ALSO
curses(3X) and related pages whose names begin "form" for detailed
descriptions of the entry points.
NOTES
The header file <> automatically includes the header file
<>.
PORTABILITY
These routines emulate the System V forms library. They were not sup-
ported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
Raymond.
formfieldbuffer(3X)
|