formfieldbuffer(3X) formfieldbuffer(3X)

NAME
       ffoorrmmffiieellddbbuuffffeerr - field buffer control

SYNOPSIS
       ##iinncclluuddee <>
       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  sseettffiieellddbbuuffffeerr  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 nnbbuuff argument  of  (see  ffoorrmmffiieellddnneeww(3X))  but  are  not
       manipulated  by  the  forms library.  The function ffiieellddbbuuffffeerr 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 do not use  it  for  long
       term storage of the entered form data.

       The function sseettffiieellddssttaattuuss sets the associated status flag of field;
       ffiieellddssttaattuuss gets the current value.  The  status  flag  is  set  to  a
       nonzero value whenever the field changes.

       The  function  sseettmmaaxxffiieelldd sets the maximum size for a dynamic field.
       An argument of 0 turns off any maximum size threshold for that field.

RREETTUURRNN VVAALLUUEE
       The ffiieellddbbuuffffeerr function returns NULL on error.

       The ffiieellddssttaattuuss function returns TTRRUUEE or FFAALLSSEE.

       The remaining routines return one of the following:

       EEOOKK The routine succeeded.

       EESSYYSSTTEEMMEERRRROORR
            System error occurred (see eerrrrnnoo).

       EEBBAADDAARRGGUUMMEENNTT
            Routine detected an incorrect or out-of-range argument.

SEE ALSO
       ccuurrsseess(3X) and related pages whose names  begin  "form"  for  detailed
       descriptions of the entry points.

NNOOTTEESS
       The header file <> automatically includes the header file

       When  configured for wide-characters, ffiieellddbbuuffffeerr returns a pointer to
       temporary storage (allocated and freed by the library).   The  applica-
       tion  should  not  attempt to modify the data.  It will be freed on the
       next call to ffiieellddbbuuffffeerr to return the same buffer.  <>.

PPOORRTTAABBIILLIITTYY
       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)