3 ****************************************************************************
4 * Copyright 2018-2022,2023 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: form_new.3x,v 1.24 2023/09/16 23:37:03 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_new 3x 2023-09-16 ncurses 6.4 Library calls</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">form_new 3x 2023-09-16 ncurses 6.4 Library calls</H1>
45 <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> Library calls <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>new_form</STRONG>, <STRONG>free_form</STRONG> - create and destroy forms
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 <STRONG>FORM</STRONG> <STRONG>*new_form(FIELD</STRONG> <STRONG>**</STRONG><EM>fields</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>free_form(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62 The function <STRONG>new_form</STRONG> creates a new form connected to a specified field
63 pointer array (which must be <STRONG>NULL</STRONG>-terminated).
65 The function <STRONG>free_form</STRONG> disconnects <EM>form</EM> from its field array and frees
66 the storage allocated for the form.
69 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
70 The function <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error. It sets <STRONG>errno</STRONG> according
71 to the function's success:
73 <STRONG>E_OK</STRONG> The routine succeeded.
75 <STRONG>E_BAD_ARGUMENT</STRONG>
76 Routine detected an incorrect or out-of-range argument.
78 <STRONG>E_CONNECTED</STRONG>
79 The field is already connected to a form.
81 <STRONG>E_SYSTEM_ERROR</STRONG>
82 System error occurred, e.g., malloc failure.
84 The function <STRONG>free_form</STRONG> returns one of the following:
86 <STRONG>E_OK</STRONG> The routine succeeded.
88 <STRONG>E_BAD_ARGUMENT</STRONG>
89 Routine detected an incorrect or out-of-range argument.
91 <STRONG>E_POSTED</STRONG>
92 The form has already been posted.
95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
96 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
100 The header file <STRONG><form.h></STRONG> automatically includes the header file
101 <STRONG><curses.h></STRONG>.
104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
105 These routines emulate the System V forms library. They were not
106 supported on Version 7 or BSD versions.
109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
110 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
115 ncurses 6.4 2023-09-16 <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
119 <li><a href="#h2-NAME">NAME</a></li>
120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>