man/form_post.3x

   1 '\" t
   2 .TH form_post 3X ""
   3 .SH NAME
   4 \fBform_post\fR - write or erase forms from associated subwindows
   5 .SH SYNOPSIS
   6 \fB#include <form.h>\fR
   7 .br
   8 int post_form(FORM *form);
   9 .br
  10 int unpost_form(FORM *form);
  11 .br
  12 .SH DESCRIPTION
  13 The function \fBpost_form\fR displays a form to its associated subwindow.  To
  14 trigger physical display of the subwindow, use \fBrefresh\fR or some equivalent
  15 \fBcurses\fR routine (the implicit \fBdoupdate\fR triggered by an \fBcurses\fR
  16 input request will do).
  17
  18 The function \fBunpost_form\fR erases form from its associated subwindow.
  19 .SH RETURN VALUE
  20 These routines return one of the following:
  21 .TP 5
  22 \fBE_OK\fR
  23 The routine succeeded.
  24 .TP 5
  25 \fBE_SYSTEM_ERROR\fR
  26 System error occurred (see \fBerrno\fR).
  27 .TP 5
  28 \fBE_BAD_ARGUMENT\fR
  29 Routine detected an incorrect or out-of-range argument.
  30 .TP 5
  31 \fBE_POSTED\fR
  32 The form has already been posted.
  33 .TP 5
  34 \fBE_BAD_STATE\fR
  35 Routine was called from an initialization or termination function.
  36 .TP 5
  37 \fBE_NO_ROOM\fR
  38 Form is too large for its window.
  39 .TP 5
  40 \fBE_NOT_POSTED\fR
  41 The form has not been posted.
  42 .TP 5
  43 \fBE_NOT_CONNECTED\fR
  44 No items are connected to the form.
  45 .SH SEE ALSO
  46 \fBcurses\fR(3X), \fBform\fR(3X).
  47 .SH NOTES
  48 The header file \fB<form.h>\fR automatically includes the header file
  49 \fB<curses.h>\fR.
  50 .SH PORTABILITY
  51 These routines emulate the System V forms library.  They were not supported on
  52 Version 7 or BSD versions.
  53 .SH AUTHORS
  54 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  55 S. Raymond.
  56 .\"#
  57 .\"# The following sets edit modes for GNU EMACS
  58 .\"# Local Variables:
  59 .\"# mode:nroff
  60 .\"# fill-column:79
  61 .\"# End: