ncurses 6.0 - patch 20151205
[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 http://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>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>new_form</STRONG>, <STRONG>free_form</STRONG> - create and destroy forms
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        FORM *new_form(FIELD **fields);
58        int free_form(FORM *form);
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The  function  <STRONG>new_form</STRONG>  creates a new form connected to a
64        specified field pointer array (which must  be  <STRONG>NULL</STRONG>-termi-
65        nated).
66
67        The  function  <STRONG>free_form</STRONG>  disconnects  <EM>form</EM> from its field
68        array and frees the storage allocated for the form.
69
70
71 </PRE>
72 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The function <STRONG>new_form</STRONG> returns  <STRONG>NULL</STRONG>  on  error.   It  sets
74        errno according to the function's success:
75
76        <STRONG>E_OK</STRONG> The routine succeeded.
77
78        <STRONG>E_BAD_ARGUMENT</STRONG>
79             Routine  detected  an incorrect or out-of-range argu-
80             ment.
81
82        <STRONG>E_CONNECTED</STRONG>
83             The field is already connected to a form.
84
85        <STRONG>E_SYSTEM_ERROR</STRONG>
86             System error occurred, e.g., malloc failure.
87
88        The function <STRONG>free_form</STRONG> returns one of the following:
89
90        <STRONG>E_OK</STRONG> The routine succeeded.
91
92        <STRONG>E_BAD_ARGUMENT</STRONG>
93             Routine detected an incorrect or  out-of-range  argu-
94             ment.
95
96        <STRONG>E_POSTED</STRONG>
97             The form has already been posted.
98
99
100 </PRE>
101 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
103
104
105 </PRE>
106 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
108        file <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE>
112 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These routines emulate the System V forms  library.   They
114        were not supported on Version 7 or BSD versions.
115
116
117 </PRE>
118 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
119        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
120        curses by Eric S. Raymond.
121
122
123
124                                                            <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
125 </PRE>
126 <div class="nav">
127 <ul>
128 <li><a href="#h2-NAME">NAME</a></li>
129 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
130 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
131 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
132 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
133 <li><a href="#h2-NOTES">NOTES</a></li>
134 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
135 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
136 </ul>
137 </div>
138 </BODY>
139 </HTML>