ncurses 5.7 - patch 20101204
[ncurses.git] / man / form_new.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2006,2010 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.9 2010/12/04 18:40:45 tom 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 .PP
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 It sets errno according to the function's success:
50 .TP 5
51 .B E_OK
52 The routine succeeded.
53 .TP 5
54 .B E_BAD_ARGUMENT
55 Routine detected an incorrect or out-of-range argument.
56 .TP 5
57 .B E_CONNECTED
58 The field is already connected to a form.
59 .TP 5
60 .B E_SYSTEM_ERROR
61 System error occurred, e.g., malloc failure.
62 .PP
63 The function \fBfree_form\fR returns one of the following:
64 .TP 5
65 .B E_OK
66 The routine succeeded.
67 .TP 5
68 .B E_BAD_ARGUMENT
69 Routine detected an incorrect or out-of-range argument.
70 .TP 5
71 .B E_POSTED
72 The form has already been posted.
73 .SH SEE ALSO
74 \fBcurses\fR(3X), \fBform\fR(3X).
75 .SH NOTES
76 The header file \fB<form.h>\fR automatically includes the header file
77 \fB<curses.h>\fR.
78 .SH PORTABILITY
79 These routines emulate the System V forms library.  They were not supported on
80 Version 7 or BSD versions.
81 .SH AUTHORS
82 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
83 S. Raymond.