ncurses 5.1
[ncurses.git] / doc / html / man / form_field.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_field</B> - make and break connections between fields and
9        forms
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;form.h&gt;</B>
15        int set_form_fields(FORM *form, FIELD **fields);
16        FIELD **form_fields(const FORM *form);
17        int field_count(const FORM *form);
18        int move_field(FIELD *field, int frow, int fcol);
19
20
21 </PRE>
22 <H2>DESCRIPTION</H2><PRE>
23        The function <B>set_form_fields</B>  changes  the  field  pointer
24        array  of the given <I>form</I>.  The array must be terminated by
25        a <B>NULL</B>.
26
27        The function <B>form_fields</B> returns the field  array  of  the
28        given form.
29
30        The  function  <B>field_count</B>  returns the count of fields in
31        <I>form</I>.
32
33        The function <B>move_field</B> move the given field  (which  must
34        be disconnected) to a specified location on the screen.
35
36
37 </PRE>
38 <H2>RETURN VALUES</H2><PRE>
39        The function <B>form_fields</B> returns <B>NULL</B> on error.
40
41        The  function  <B>field_count</B> returns <B>ERR</B> (the general <B>curses</B>
42        error return value) on error.
43
44        The functions <B>set_form_fields</B> and <B>move_field</B> return one of
45        the following codes on error:
46
47        <B>E_OK</B> The routine succeeded.
48
49        <B>E_SYSTEM_ERROR</B>
50             System error occurred (see <B>errno</B>).
51
52        <B>E_BAD_ARGUMENT</B>
53             Routine  detected  an incorrect or out-of-range argu-
54             ment.
55
56        <B>E_POSTED</B>
57             The form is already posted.
58
59        <B>E_CONNECTED</B>
60             The field is already connected to a form.
61
62
63 </PRE>
64 <H2>SEE ALSO</H2><PRE>
65        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
66
67
68 </PRE>
69 <H2>NOTES</H2><PRE>
70        The header file <B>&lt;form.h&gt;</B> automatically includes the header
71        file <B>&lt;curses.h&gt;</B>.
72
73
74 </PRE>
75 <H2>PORTABILITY</H2><PRE>
76        These  routines  emulate the System V forms library.  They
77        were not supported on Version 7 or BSD versions.
78
79        The  SVr4  forms  library  documentation   specifies   the
80        <B>field_count</B> error value as -1 (which is the value of <B>ERR</B>).
81
82
83 </PRE>
84 <H2>AUTHORS</H2><PRE>
85        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
86        curses by Eric S. Raymond.
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129 </PRE>
130 <HR>
131 <ADDRESS>
132 Man(1) output converted with
133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
134 </ADDRESS>
135 </BODY>
136 </HTML>