7b0d91bbdd073ce8a1b17fa48305f909ecc32f81
[ncurses.git] / doc / html / man / form_new.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>form_new</B> - create and destroy forms
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;form.h&gt;</B>
14        FORM *new_form(FIELD **fields);
15        int free_form(FORM *form);
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        The  function  <B>new_form</B>  creates a new form connected to a
21        specified field pointer array (which must  be  <B>NULL</B>-termi-
22        nated).
23
24        The  function  <B>free_form</B>  disconnects  <I>form</I> from its field
25        array and frees the storage allocated for the form.
26
27
28 </PRE>
29 <H2>RETURN VALUE</H2><PRE>
30        The function <B>new_form</B> returns <B>NULL</B> on error.
31
32        The function <B>free_form</B> returns one of the following:
33
34        <B>E_OK</B> The routine succeeded.
35
36        <B>E_SYSTEM_ERROR</B>
37             System error occurred (see <B>errno</B>).
38
39        <B>E_BAD_ARGUMENT</B>
40             Routine detected an incorrect or  out-of-range  argu-
41             ment.
42
43        <B>E_POSTED</B>
44             The form has already been posted.
45
46
47 </PRE>
48 <H2>SEE ALSO</H2><PRE>
49        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
50
51
52 </PRE>
53 <H2>NOTES</H2><PRE>
54        The header file <B>&lt;form.h&gt;</B> automatically includes the header
55        file <B>&lt;curses.h&gt;</B>.
56
57
58 </PRE>
59 <H2>PORTABILITY</H2><PRE>
60        These routines emulate the System V forms  library.   They
61        were not supported on Version 7 or BSD versions.
62
63
64 </PRE>
65 <H2>AUTHORS</H2><PRE>
66        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
67        curses by Eric S. Raymond.
68
69
70
71
72
73
74
75 </PRE>
76 <HR>
77 <ADDRESS>
78 Man(1) output converted with
79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
80 </ADDRESS>
81 </BODY>
82 </HTML>