ncurses 6.2 - patch 20210403
[ncurses.git] / man / form_post.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
5 .\"                                                                          *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
7 .\" copy of this software and associated documentation files (the            *
8 .\" "Software"), to deal in the Software without restriction, including      *
9 .\" without limitation the rights to use, copy, modify, merge, publish,      *
10 .\" distribute, distribute with modifications, sublicense, and/or sell       *
11 .\" copies of the Software, and to permit persons to whom the Software is    *
12 .\" furnished to do so, subject to the following conditions:                 *
13 .\"                                                                          *
14 .\" The above copyright notice and this permission notice shall be included  *
15 .\" in all copies or substantial portions of the Software.                   *
16 .\"                                                                          *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24 .\"                                                                          *
25 .\" Except as contained in this notice, the name(s) of the above copyright   *
26 .\" holders shall not be used in advertising or otherwise to promote the     *
27 .\" sale, use or other dealings in this Software without prior written       *
28 .\" authorization.                                                           *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: form_post.3x,v 1.16 2020/10/18 00:01:05 tom Exp $
32 .TH form_post 3X ""
33 .SH NAME
34 \fBpost_form\fR,
35 \fBunpost_form\fR \- write or erase forms from associated subwindows
36 .SH SYNOPSIS
37 \fB#include <form.h>\fR
38 .sp
39 \fBint post_form(FORM *\fP\fIform\fP\fB);\fP
40 .br
41 \fBint unpost_form(FORM *\fP\fIform\fP\fB);\fP
42 .br
43 .SH DESCRIPTION
44 The function \fBpost_form\fR displays a form to its associated subwindow.
45 To trigger physical display of the subwindow,
46 use \fBrefresh\fR(3X) or some equivalent
47 \fBcurses\fR routine (the implicit \fBdoupdate\fR triggered by an \fBcurses\fR
48 input request will do).
49 .PP
50 The function \fBunpost_form\fR erases form from its associated subwindow.
51 .SH RETURN VALUE
52 These routines return one of the following:
53 .TP 5
54 .B E_OK
55 The routine succeeded.
56 .TP 5
57 .B E_BAD_ARGUMENT
58 Routine detected an incorrect or out-of-range argument.
59 .TP 5
60 .B E_BAD_STATE
61 Routine was called from an initialization or termination function.
62 .TP 5
63 .B E_NOT_POSTED
64 The form has not been posted.
65 .TP 5
66 .B E_NOT_CONNECTED
67 No items are connected to the form.
68 .TP 5
69 .B E_NO_ROOM
70 Form is too large for its window.
71 .TP 5
72 .B E_POSTED
73 The form has already been posted.
74 .TP 5
75 .B E_SYSTEM_ERROR
76 System error occurred (see \fBerrno\fR(3)).
77 .
78 .SH SEE ALSO
79 \fBcurses\fR(3X), \fBform\fR(3X).
80 .SH NOTES
81 The header file \fB<form.h>\fR automatically includes the header file
82 \fB<curses.h>\fR.
83 .SH PORTABILITY
84 These routines emulate the System V forms library.
85 They were not supported on
86 Version 7 or BSD versions.
87 .SH AUTHORS
88 Juergen Pfeifer.
89 Manual pages and adaptation for new curses by Eric S. Raymond.