ncurses 6.1 - patch 20180721
[ncurses.git] / doc / html / man / form_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 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_new.3x,v 1.10 2015/12/05 23:01:16 tom 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 https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_new 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_new 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>                                                      <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>new_form</STRONG>, <STRONG>free_form</STRONG> - create and destroy forms
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
55        FORM *new_form(FIELD **fields);
56        int free_form(FORM *form);
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        The function <STRONG>new_form</STRONG> creates a new form connected to a specified field
61        pointer array (which must be <STRONG>NULL</STRONG>-terminated).
62
63        The function <STRONG>free_form</STRONG> disconnects <EM>form</EM> from its field array and  frees
64        the storage allocated for the form.
65
66
67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
68        The  function  <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error.  It sets errno according
69        to the function's success:
70
71        <STRONG>E_OK</STRONG> The routine succeeded.
72
73        <STRONG>E_BAD_ARGUMENT</STRONG>
74             Routine detected an incorrect or out-of-range argument.
75
76        <STRONG>E_CONNECTED</STRONG>
77             The field is already connected to a form.
78
79        <STRONG>E_SYSTEM_ERROR</STRONG>
80             System error occurred, e.g., malloc failure.
81
82        The function <STRONG>free_form</STRONG> returns one of the following:
83
84        <STRONG>E_OK</STRONG> The routine succeeded.
85
86        <STRONG>E_BAD_ARGUMENT</STRONG>
87             Routine detected an incorrect or out-of-range argument.
88
89        <STRONG>E_POSTED</STRONG>
90             The form has already been posted.
91
92
93 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
94        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
95
96
97 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
98        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
99        <STRONG>&lt;curses.h&gt;</STRONG>.
100
101
102 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
103        These  routines emulate the System V forms library.  They were not sup-
104        ported on Version 7 or BSD versions.
105
106
107 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
108        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
109        Raymond.
110
111
112
113                                                                   <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
114 </PRE>
115 <div class="nav">
116 <ul>
117 <li><a href="#h2-NAME">NAME</a></li>
118 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
122 <li><a href="#h2-NOTES">NOTES</a></li>
123 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
124 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
125 </ul>
126 </div>
127 </BODY>
128 </HTML>