ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / form_new.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018,2020 Thomas E. Dickey                                     *
5   * Copyright 1998-2010,2015 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.15 2020/10/24 09:02:26 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_new 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_new 3X</H1>
44 <PRE>
45 <B><A HREF="form_new.3X.html">form_new(3X)</A></B>                                                      <B><A HREF="form_new.3X.html">form_new(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>new_form</B>, <B>free_form</B> - create and destroy forms
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;form.h&gt;</B>
56
57        <B>FORM</B> <B>*new_form(FIELD</B> <B>**</B><I>fields</I><B>);</B>
58        <B>int</B> <B>free_form(FORM</B> <B>*</B><I>form</I><B>);</B>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        The function <B>new_form</B> creates a new form connected to a specified field
63        pointer array (which must be <B>NULL</B>-terminated).
64
65        The function <B>free_form</B> disconnects <I>form</I> from its field array and  frees
66        the storage allocated for the form.
67
68
69 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
70        The  function  <B>new_form</B> returns <B>NULL</B> on error.  It sets <B>errno</B> according
71        to the function's success:
72
73        <B>E_OK</B> The routine succeeded.
74
75        <B>E_BAD_ARGUMENT</B>
76             Routine detected an incorrect or out-of-range argument.
77
78        <B>E_CONNECTED</B>
79             The field is already connected to a form.
80
81        <B>E_SYSTEM_ERROR</B>
82             System error occurred, e.g., malloc failure.
83
84        The function <B>free_form</B> returns one of the following:
85
86        <B>E_OK</B> The routine succeeded.
87
88        <B>E_BAD_ARGUMENT</B>
89             Routine detected an incorrect or out-of-range argument.
90
91        <B>E_POSTED</B>
92             The form has already been posted.
93
94
95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
96        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
97
98
99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
100        The  header  file  <B>&lt;form.h&gt;</B>  automatically  includes  the  header  file
101        <B>&lt;curses.h&gt;</B>.
102
103
104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
105        These  routines  emulate  the  System  V  forms library.  They were not
106        supported on Version 7 or BSD versions.
107
108
109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
110        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
111        Raymond.
112
113
114
115                                                                   <B><A HREF="form_new.3X.html">form_new(3X)</A></B>
116 </PRE>
117 <div class="nav">
118 <ul>
119 <li><a href="#h2-NAME">NAME</a></li>
120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
127 </ul>
128 </div>
129 </BODY>
130 </HTML>