ncurses 5.3
[ncurses.git] / doc / html / man / form_new.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_new.3x,v 1.5 1998/11/29 01:07:37 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_new 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_new 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_new</STRONG> - create and destroy forms
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        FORM *new_form(FIELD **fields);
54        int free_form(FORM *form);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The  function  <STRONG>new_form</STRONG>  creates a new form connected to a
60        specified field pointer array (which must  be  <STRONG>NULL</STRONG>-termi-
61        nated).
62
63        The  function  <STRONG>free_form</STRONG>  disconnects  <EM>form</EM> from its field
64        array and frees the storage allocated for the form.
65
66
67 </PRE>
68 <H2>RETURN VALUE</H2><PRE>
69        The function <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error.
70
71        The function <STRONG>free_form</STRONG> returns one of the following:
72
73        <STRONG>E_OK</STRONG> The routine succeeded.
74
75        <STRONG>E_SYSTEM_ERROR</STRONG>
76             System error occurred (see <STRONG>errno</STRONG>).
77
78        <STRONG>E_BAD_ARGUMENT</STRONG>
79             Routine detected an incorrect or  out-of-range  argu-
80             ment.
81
82        <STRONG>E_POSTED</STRONG>
83             The form has already been posted.
84
85
86 </PRE>
87 <H2>SEE ALSO</H2><PRE>
88        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
89
90
91 </PRE>
92 <H2>NOTES</H2><PRE>
93        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
94        file <STRONG>&lt;curses.h&gt;</STRONG>.
95
96
97 </PRE>
98 <H2>PORTABILITY</H2><PRE>
99        These routines emulate the System V forms  library.   They
100        were not supported on Version 7 or BSD versions.
101
102
103 </PRE>
104 <H2>AUTHORS</H2><PRE>
105        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
106        curses by Eric S. Raymond.
107
108
109
110
111
112
113
114 </PRE>
115 <HR>
116 <ADDRESS>
117 Man(1) output converted with
118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
119 </ADDRESS>
120 </BODY>
121 </HTML>