1a8d4ea832ab866983ba4b15f72c74a77b3022a8
[ncurses.git] / doc / html / man / form_new_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_new_page</B> - form pagination functions
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;form.h&gt;</B>
14        int set_new_page(FIELD *field, bool new_page_flag);
15        bool new_page(const FIELD *field);
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        The  function  <B>set_new_page</B>  sets or resets a flag marking
21        the given field as the beginning of  a  new  page  on  its
22        form.
23
24        The  function  <B>new_page</B>  is  a  predicate which tests if a
25        given field marks a page beginning on its form.
26
27
28 </PRE>
29 <H2>RETURN VALUE</H2><PRE>
30        The function <B>new_page</B> returns <B>TRUE</B> or <B>FALSE</B>.
31
32        The function <B>set_new_page</B> return one of the following:
33
34        <B>E_OK</B> The routine succeeded.
35
36        <B>E_SYSTEM_ERROR</B>
37             System error occurred (see <B>errno</B>).
38
39        <B>E_CONNECTED</B>
40             The given field is already connected to a form.
41
42
43 </PRE>
44 <H2>SEE ALSO</H2><PRE>
45        <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages  whose  names  begin  "form_"  for
46        detailed descriptions of the entry points.
47
48
49 </PRE>
50 <H2>NOTES</H2><PRE>
51        The header file <B>&lt;form.h&gt;</B> automatically includes the header
52        file <B>&lt;curses.h&gt;</B>.
53
54
55 </PRE>
56 <H2>PORTABILITY</H2><PRE>
57        These routines emulate the System V forms  library.   They
58        were not supported on Version 7 or BSD versions.
59
60
61 </PRE>
62 <H2>AUTHORS</H2><PRE>
63        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
64        curses by Eric S. Raymond.
65
66
67
68
69
70
71
72
73
74
75 </PRE>
76 <HR>
77 <ADDRESS>
78 Man(1) output converted with
79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
80 </ADDRESS>
81 </BODY>
82 </HTML>