874bda872de15e3a5f68eb138ed171e7554b747c
[ncurses.git] / doc / html / man / form_page.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_page</B> - set and get form page number
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;form.h&gt;</B>
14        int set_current_field(FORM *form, FIELD *field);
15        FIELD *current_field(const FORM *);
16        int set_form_page(FORM *form, int n);
17        int form_page(const FORM *form);
18        int field_index(const FIELD *field);
19
20
21 </PRE>
22 <H2>DESCRIPTION</H2><PRE>
23        The  function  <B>set_current</B> <B>field</B> sets the current field of
24        the given form; <B>current_field</B> returns the current field of
25        the given form.
26
27        The  function  <B>set_form_page</B>  sets  the form's page number
28        (goes to page <I>n</I> of the form).
29
30        The function <B>form_page</B> returns  the  form's  current  page
31        number.
32
33        The function <B>field_index</B> returns the index of the field in
34        the field array of the form it is connected to. It returns
35        <B>ERR</B>  if  the  argument is the null pointer or the field is
36        not connected.
37
38
39 </PRE>
40 <H2>RETURN VALUE</H2><PRE>
41        Except for <B>form_page</B>, each routine returns one of the fol-
42        lowing:
43
44        <B>E_OK</B> The routine succeeded.
45
46        <B>E_SYSTEM_ERROR</B>
47             System error occurred (see <B>errno</B>).
48
49        <B>E_BAD_ARGUMENT</B>
50             Routine  detected  an incorrect or out-of-range argu-
51             ment.
52
53        <B>E_BAD_STATE</B>
54             Routine was called from an initialization or termina-
55             tion function.
56
57        <B>E_INVALID_FIELD</B>
58             Contents of a field are not valid.
59
60        <B>E_REQUEST_DENIED</B>
61             The form driver could not process the request.
62
63
64 </PRE>
65 <H2>SEE ALSO</H2><PRE>
66        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
67
68
69
70 </PRE>
71 <H2>NOTES</H2><PRE>
72        The header file <B>&lt;form.h&gt;</B> automatically includes the header
73        file <B>&lt;curses.h&gt;</B>.
74
75
76 </PRE>
77 <H2>PORTABILITY</H2><PRE>
78        These routines emulate the System V forms  library.   They
79        were not supported on Version 7 or BSD versions.
80
81
82 </PRE>
83 <H2>AUTHORS</H2><PRE>
84        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
85        curses by Eric S. Raymond.
86
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>