1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: form_new.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
31 .TH form_new 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
35 create and destroy forms
40 \fBFORM *new_form(FIELD **\fIfields\fP);
41 \fBint free_form(FORM *\fIform\fP);
44 The function \fBnew_form\fP creates a new form connected to a specified field
45 pointer array (which must be \fBNULL\fP-terminated).
47 The function \fBfree_form\fP disconnects \fIform\fP from its field array
48 and frees the storage allocated for the form.
50 The function \fBnew_form\fP returns \fBNULL\fP on error.
51 It sets \fBerrno\fP according to the function's success:
54 The routine succeeded.
57 Routine detected an incorrect or out-of-range argument.
60 The field is already connected to a form.
63 System error occurred, e.g., malloc failure.
65 The function \fBfree_form\fP returns one of the following:
68 The routine succeeded.
71 Routine detected an incorrect or out-of-range argument.
74 The form has already been posted.
76 These routines emulate the System V forms library.
77 They were not supported on
78 Version 7 or BSD versions.
81 Manual pages and adaptation for new curses by Eric S. Raymond.