ncurses 5.3
[ncurses.git] / doc / html / man / form_new_page.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2002 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_new_page.3x,v 1.6 2002/01/19 22:48:51 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_new_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_new_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_new_page</STRONG> - form pagination functions
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        int set_new_page(FIELD *field, bool new_page_flag);
54        bool new_page(const FIELD *field);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The  function  <STRONG>set_new_page</STRONG>  sets or resets a flag marking
60        the given field as the beginning of  a  new  page  on  its
61        form.
62
63        The  function  <STRONG>new_page</STRONG>  is  a  predicate which tests if a
64        given field marks a page beginning on its form.
65
66
67 </PRE>
68 <H2>RETURN VALUE</H2><PRE>
69        The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
70
71        The function <STRONG>set_new_page</STRONG> return one of the following:
72
73        <STRONG>E_OK</STRONG> The routine succeeded.
74
75        <STRONG>E_SYSTEM_ERROR</STRONG>
76             System error occurred (see <STRONG>errno</STRONG>).
77
78        <STRONG>E_CONNECTED</STRONG>
79             The given field is already connected to a form.
80
81
82 </PRE>
83 <H2>SEE ALSO</H2><PRE>
84        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
85        detailed descriptions of the entry points.
86
87
88 </PRE>
89 <H2>NOTES</H2><PRE>
90        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
91        file <STRONG>&lt;curses.h&gt;</STRONG>.
92
93
94 </PRE>
95 <H2>PORTABILITY</H2><PRE>
96        These routines emulate the System V forms  library.   They
97        were not supported on Version 7 or BSD versions.
98
99
100 </PRE>
101 <H2>AUTHORS</H2><PRE>
102        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
103        curses by Eric S. Raymond.
104
105
106
107
108
109
110
111
112
113
114 </PRE>
115 <HR>
116 <ADDRESS>
117 Man(1) output converted with
118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
119 </ADDRESS>
120 </BODY>
121 </HTML>