ncurses 5.3
[ncurses.git] / doc / html / man / form_page.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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_page.3x,v 1.8 1998/11/29 01:08:02 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_page 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_page 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_page</STRONG> - set and get form page number
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        int set_current_field(FORM *form, FIELD *field);
54        FIELD *current_field(const FORM *);
55        int set_form_page(FORM *form, int n);
56        int form_page(const FORM *form);
57        int field_index(const FIELD *field);
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        The  function  <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
63        the given form; <STRONG>current_field</STRONG> returns the current field of
64        the given form.
65
66        The  function  <STRONG>set_form_page</STRONG>  sets  the form's page number
67        (goes to page <EM>n</EM> of the form).
68
69        The function <STRONG>form_page</STRONG> returns  the  form's  current  page
70        number.
71
72        The function <STRONG>field_index</STRONG> returns the index of the field in
73        the field array of the form it is connected to. It returns
74        <STRONG>ERR</STRONG>  if  the  argument is the null pointer or the field is
75        not connected.
76
77
78 </PRE>
79 <H2>RETURN VALUE</H2><PRE>
80        Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
81        lowing:
82
83        <STRONG>E_OK</STRONG> The routine succeeded.
84
85        <STRONG>E_SYSTEM_ERROR</STRONG>
86             System error occurred (see <STRONG>errno</STRONG>).
87
88        <STRONG>E_BAD_ARGUMENT</STRONG>
89             Routine  detected  an incorrect or out-of-range argu-
90             ment.
91
92        <STRONG>E_BAD_STATE</STRONG>
93             Routine was called from an initialization or termina-
94             tion function.
95
96        <STRONG>E_INVALID_FIELD</STRONG>
97             Contents of a field are not valid.
98
99        <STRONG>E_REQUEST_DENIED</STRONG>
100             The form driver could not process the request.
101
102
103 </PRE>
104 <H2>SEE ALSO</H2><PRE>
105        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
106
107
108
109 </PRE>
110 <H2>NOTES</H2><PRE>
111        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
112        file <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE>
116 <H2>PORTABILITY</H2><PRE>
117        These routines emulate the System V forms  library.   They
118        were not supported on Version 7 or BSD versions.
119
120
121 </PRE>
122 <H2>AUTHORS</H2><PRE>
123        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
124        curses by Eric S. Raymond.
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>