ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / form_post.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 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   * @Id: form_post.3x,v 1.10 2015/12/05 20:41:37 jmc Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_post 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_post 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>                                             <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>post_form</STRONG>, <STRONG>unpost_form</STRONG> - write or erase forms from associ-
52        ated subwindows
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        int post_form(FORM *form);
59        int unpost_form(FORM *form);
60
61
62 </PRE>
63 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        The function <STRONG>post_form</STRONG> displays a form to  its  associated
65        subwindow.   To trigger physical display of the subwindow,
66        use  <STRONG>refresh</STRONG>  or  some  equivalent  <STRONG>curses</STRONG>  routine   (the
67        implicit  <STRONG>doupdate</STRONG>  triggered  by  an <STRONG>curses</STRONG> input request
68        will do).
69
70        The function <STRONG>unpost_form</STRONG> erases form from  its  associated
71        subwindow.
72
73
74 </PRE>
75 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76        These routines return one of the following:
77
78        <STRONG>E_OK</STRONG> The routine succeeded.
79
80        <STRONG>E_BAD_ARGUMENT</STRONG>
81             Routine  detected  an incorrect or out-of-range argu-
82             ment.
83
84        <STRONG>E_BAD_STATE</STRONG>
85             Routine was called from an initialization or termina-
86             tion function.
87
88        <STRONG>E_NOT_POSTED</STRONG>
89             The form has not been posted.
90
91        <STRONG>E_NOT_CONNECTED</STRONG>
92             No items are connected to the form.
93
94        <STRONG>E_NO_ROOM</STRONG>
95             Form is too large for its window.
96
97        <STRONG>E_POSTED</STRONG>
98             The form has already been posted.
99
100        <STRONG>E_SYSTEM_ERROR</STRONG>
101             System error occurred (see <STRONG>errno</STRONG>).
102
103
104 </PRE>
105 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
106        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
107
108
109 </PRE>
110 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
111        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
112        file <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE>
116 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
117        These routines emulate the System V forms  library.   They
118        were not supported on Version 7 or BSD versions.
119
120
121 </PRE>
122 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
123        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
124        curses by Eric S. Raymond.
125
126
127
128                                                           <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
129 </PRE>
130 <div class="nav">
131 <ul>
132 <li><a href="#h2-NAME">NAME</a></li>
133 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
134 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
135 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
136 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
137 <li><a href="#h2-NOTES">NOTES</a></li>
138 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
139 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
140 </ul>
141 </div>
142 </BODY>
143 </HTML>