1 FORM_FIELD_BUFFER(3CURSES)                            Curses Library Functions
   2 
   3 
   4 
   5 NAME
   6        form_field_buffer, set_field_buffer, field_buffer, set_field_status,
   7        field_status, set_max_field - set and get forms field attributes
   8 
   9 SYNOPSIS
  10        cc [ flag... ] file... -lform  -lcurses  [ library... ]
  11        #include <form.h>
  12 
  13 
  14 
  15        int set_field_buffer(FIELD *field, int buf, char *value);
  16 
  17 
  18        char *field_buffer(FIELD *field, int buf);
  19 
  20 
  21        int set_field_status(FIELD *field, int status);
  22 
  23 
  24        int field_status(FIELD *field);
  25 
  26 
  27        int set_max_field(FIELD *field, int max);
  28 
  29 
  30 DESCRIPTION
  31        set_field_buffer() sets buffer buf of field to value.  Buffer 0 stores
  32        the displayed contents of the field. Buffers other than 0 are
  33        application specific and not used by the forms library routines.
  34        field_buffer() returns the value of field buffer buf.
  35 
  36 
  37        Every field has an associated status flag that is set whenever the
  38        contents of field buffer 0 changes. set_field_status() sets the status
  39        flag of field to status. field_status() returns the status of field.
  40 
  41 
  42        set_max_field() sets a maximum growth on a dynamic field, or if max=0
  43        turns off any maximum growth.
  44 
  45 RETURN VALUES
  46        field_buffer() returns NULL on error.
  47 
  48 
  49        field_status() returns TRUE or FALSE.
  50 
  51 
  52        set_field_buffer(), set_field_status(), and set_max_field() return one
  53        of the following:
  54 
  55        E_OK
  56                          The function returned successfully.
  57 
  58 
  59        E_SYSTEM_ERROR
  60                          System error
  61 
  62 
  63        E_BAD_ARGUMENT
  64                          An argument is incorrect.
  65 
  66 
  67 ATTRIBUTES
  68        See attributes(5) for descriptions of the following attributes:
  69 
  70 
  71 
  72 
  73        +---------------+-----------------+
  74        |ATTRIBUTE TYPE | ATTRIBUTE VALUE |
  75        +---------------+-----------------+
  76        |MT-Level       | Unsafe          |
  77        +---------------+-----------------+
  78 
  79 SEE ALSO
  80        curses(3CURSES), forms(3CURSES), attributes(5)
  81 
  82 NOTES
  83        The header <form.h> automatically includes the headers  <eti.h> and
  84        <curses.h>.
  85 
  86 
  87 
  88                                December 31, 1996    FORM_FIELD_BUFFER(3CURSES)