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