ncurses 5.7 - patch 20100731
[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-2006,2010 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.8 2010/07/31 16:08:48 tom 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 <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>                                               <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>form_new</STRONG> - create and destroy forms
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        FORM *new_form(FIELD **fields);
58        int free_form(FORM *form);
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        The  function  <STRONG>new_form</STRONG>  creates a new form connected to a
64        specified field pointer array (which must  be  <STRONG>NULL</STRONG>-termi-
65        nated).
66
67        The  function  <STRONG>free_form</STRONG>  disconnects  <EM>form</EM> from its field
68        array and frees the storage allocated for the form.
69
70
71 </PRE>
72 <H2>RETURN VALUE</H2><PRE>
73        The function <STRONG>new_form</STRONG> returns  <STRONG>NULL</STRONG>  on  error.   It  sets
74        errno according to the function's success:
75
76        <STRONG>E_OK</STRONG> The routine succeeded.
77
78        <STRONG>E_BAD_ARGUMENT</STRONG>
79             Routine  detected  an incorrect or out-of-range argu-
80             ment.
81
82        <STRONG>E_CONNECTED</STRONG>
83             The field is already connected to a form.
84
85        <STRONG>E_SYSTEM_ERROR</STRONG>
86             System error occurred, e.g., malloc failure.
87
88        The function <STRONG>free_form</STRONG> returns one of the following:
89
90        <STRONG>E_OK</STRONG> The routine succeeded.
91
92        <STRONG>E_BAD_ARGUMENT</STRONG>
93             Routine detected an incorrect or  out-of-range  argu-
94             ment.
95
96        <STRONG>E_POSTED</STRONG>
97             The form has already been posted.
98
99
100 </PRE>
101 <H2>SEE ALSO</H2><PRE>
102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
103
104
105 </PRE>
106 <H2>NOTES</H2><PRE>
107        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
108        file <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE>
112 <H2>PORTABILITY</H2><PRE>
113        These routines emulate the System V forms  library.   They
114        were not supported on Version 7 or BSD versions.
115
116
117 </PRE>
118 <H2>AUTHORS</H2><PRE>
119        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
120        curses by Eric S. Raymond.
121
122
123
124                                                            <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
125 </PRE>
126 <HR>
127 <ADDRESS>
128 Man(1) output converted with
129 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
130 </ADDRESS>
131 </BODY>
132 </HTML>