ncurses 5.0
[ncurses.git] / man / form_new.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
4 .\"                                                                          *
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:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
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.                               *
23 .\"                                                                          *
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       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_new.3x,v 1.5 1998/11/29 01:07:37 Rick.Ohnemus Exp $
31 .TH form_new 3X ""
32 .SH NAME
33 \fBform_new\fR - create and destroy forms
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 FORM *new_form(FIELD **fields);
38 .br
39 int free_form(FORM *form);
40 .br
41 .SH DESCRIPTION
42 The function \fBnew_form\fR creates a new form connected to a specified field
43 pointer array (which must be \fBNULL\fR-terminated).
44
45 The function \fBfree_form\fR disconnects \fIform\fR from its field array
46 and frees the storage allocated for the form.
47 .SH RETURN VALUE
48 The function \fBnew_form\fR returns \fBNULL\fR on error.
49
50 The function \fBfree_form\fR returns one of the following:
51 .TP 5
52 \fBE_OK\fR
53 The routine succeeded.
54 .TP 5
55 \fBE_SYSTEM_ERROR\fR
56 System error occurred (see \fBerrno\fR).
57 .TP 5
58 \fBE_BAD_ARGUMENT\fR
59 Routine detected an incorrect or out-of-range argument.
60 .TP 5
61 \fBE_POSTED\fR
62 The form has already been posted.
63 .SH SEE ALSO
64 \fBcurses\fR(3X), \fBform\fR(3X).
65 .SH NOTES
66 The header file \fB<form.h>\fR automatically includes the header file
67 \fB<curses.h>\fR.
68 .SH PORTABILITY
69 These routines emulate the System V forms library.  They were not supported on
70 Version 7 or BSD versions.
71 .SH AUTHORS
72 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
73 S. Raymond.
74 .\"#
75 .\"# The following sets edit modes for GNU EMACS
76 .\"# Local Variables:
77 .\"# mode:nroff
78 .\"# fill-column:79
79 .\"# End: