ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / form_post.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_post.3x,v 1.16 2020/10/18 00:01:05 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_post 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_post 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>                                                    <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>post_form</STRONG>,   <STRONG>unpost_form</STRONG>   -  write  or  erase  forms  from  associated
52        subwindows
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>post_form(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
59        <STRONG>int</STRONG> <STRONG>unpost_form(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>post_form</STRONG> displays a form to its associated subwindow.  To
64        trigger  physical  display  of  the  subwindow, use <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> or some
65        equivalent <STRONG>curses</STRONG> routine (the implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG>
66        input request will do).
67
68        The function <STRONG>unpost_form</STRONG> erases form from its associated subwindow.
69
70
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72        These routines return one of the following:
73
74        <STRONG>E_OK</STRONG> The routine succeeded.
75
76        <STRONG>E_BAD_ARGUMENT</STRONG>
77             Routine detected an incorrect or out-of-range argument.
78
79        <STRONG>E_BAD_STATE</STRONG>
80             Routine was called from an initialization or termination function.
81
82        <STRONG>E_NOT_POSTED</STRONG>
83             The form has not been posted.
84
85        <STRONG>E_NOT_CONNECTED</STRONG>
86             No items are connected to the form.
87
88        <STRONG>E_NO_ROOM</STRONG>
89             Form is too large for its window.
90
91        <STRONG>E_POSTED</STRONG>
92             The form has already been posted.
93
94        <STRONG>E_SYSTEM_ERROR</STRONG>
95             System error occurred (see <STRONG>errno(3)</STRONG>).
96
97
98 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
99        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
100
101
102 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
103        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
104        <STRONG>&lt;curses.h&gt;</STRONG>.
105
106
107 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
108        These routines emulate the System  V  forms  library.   They  were  not
109        supported on Version 7 or BSD versions.
110
111
112 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
113        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
114        Raymond.
115
116
117
118                                                                  <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
119 </PRE>
120 <div class="nav">
121 <ul>
122 <li><a href="#h2-NAME">NAME</a></li>
123 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
124 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
125 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
126 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
127 <li><a href="#h2-NOTES">NOTES</a></li>
128 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
129 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
130 </ul>
131 </div>
132 </BODY>
133 </HTML>