2 .\"***************************************************************************
3 .\" Copyright 2018-2020,2021 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
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. *
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 *
29 .\"***************************************************************************
31 .\" $Id: form_new.3x,v 1.17 2021/12/25 21:41:58 tom Exp $
35 \fBfree_form\fP \- create and destroy forms
37 \fB#include <form.h>\fP
39 \fBFORM *new_form(FIELD **\fP\fIfields\fP\fB);\fP
41 \fBint free_form(FORM *\fP\fIform\fP\fB);\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 \fBcurses\fP(3X), \fBform\fP(3X).
78 The header file \fB<form.h>\fP automatically includes the header file
81 These routines emulate the System V forms library.
82 They were not supported on
83 Version 7 or BSD versions.
86 Manual pages and adaptation for new curses by Eric S. Raymond.