man/form_field_buffer.3x

   1 '\" t
   2 .TH form_field_buffer 3X ""
   3 .SH NAME
   4 \fBform_field_buffer\fR - field buffer control
   5 .SH SYNOPSIS
   6 \fB#include <form.h>\fR
   7 .br
   8 int set_field_buffer(FIELD *field, int buf, const char *value);
   9 .br
  10 char *field_buffer(const FIELD *field, int buffer);
  11 .br
  12 int set_field_status(FIELD *field, bool status);
  13 .br
  14 bool field_status(const FIELD *field);
  15 .br
  16 int set_max_field(FIELD *field, int max);
  17 .br
  18 .SH DESCRIPTION
  19 The function \fBset_field_buffer\fR sets the numbered buffer of the given field
  20 to contain a given string.  Buffer 0 is the displayed value of the field; other
  21 numbered buffers may be allocated by applications through the \fBnbuf\fR
  22 argument of (see \fBfield_new\fR(3X)) but are not manipulated by the forms
  23 library.  The function \fBfield_buffer\fR returns the foreground attribute.
  24
  25 The function \fBset_field_status\fR sets the associated status flag of
  26 \fIfield\fR; \fBfield_status\fR gets the current value.  The status flag
  27 is set to a nonzero value whenever the field changes.
  28
  29 The function \fBset_max_field\fR sets the maximum size for a dynamic field.
  30 An argument of 0 turns off any maximum size threshold for that field.
  31 .SH RETURN VALUE
  32 The \fBfield_buffer\fR function returns NULL on error.
  33
  34 The \fBfield_status\fR function returns \fBTRUE\fR or \fBFALSE\fR.
  35
  36 The remaining routines return one of the following:
  37 .TP 5
  38 \fBE_OK\fR
  39 The routine succeeded.
  40 .TP 5
  41 \fBE_SYSTEM_ERROR\fR
  42 System error occurred (see \fBerrno\fR).
  43 .TP 5
  44 \fBE_BAD_ARGUMENT\fR
  45 Routine detected an incorrect or out-of-range argument.
  46 .SH SEE ALSO
  47 \fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
  48 descriptions of the entry points.
  49 .SH NOTES
  50 The header file \fB<form.h>\fR automatically includes the header file
  51 \fB<curses.h>\fR.
  52 .SH PORTABILITY
  53 These routines emulate the System V forms library.  They were not supported on
  54 Version 7 or BSD versions.
  55 .SH AUTHORS
  56 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  57 S. Raymond.
  58 .\"#
  59 .\"# The following sets edit modes for GNU EMACS
  60 .\"# Local Variables:
  61 .\"# mode:nroff
  62 .\"# fill-column:79
  63 .\"# End: