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