<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> <!-- * t **************************************************************************** * Copyright (c) 1998,2006 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * * "Software"), to deal in the Software without restriction, including * * without limitation the rights to use, copy, modify, merge, publish, * * distribute, distribute with modifications, sublicense, and/or sell * * copies of the Software, and to permit persons to whom the Software is * * furnished to do so, subject to the following conditions: * * * * The above copyright notice and this permission notice shall be included * * in all copies or substantial portions of the Software. * * * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * * * * Except as contained in this notice, the name(s) of the above copyright * * holders shall not be used in advertising or otherwise to promote the * * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** * @Id: form_page.3x,v 1.10 2006/11/04 18:52:32 tom Exp @ --> <HTML> <HEAD> <TITLE>form_page 3x</TITLE> <link rev=made href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> <H1>form_page 3x</H1> <HR> <PRE> <!-- Manpage converted by man2html 3.0.1 --> <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> </PRE> <H2>NAME</H2><PRE> <STRONG>form_page</STRONG> - set and get form page number </PRE> <H2>SYNOPSIS</H2><PRE> <STRONG>#include</STRONG> <STRONG><form.h></STRONG> int set_current_field(FORM *form, FIELD *field); FIELD *current_field(const FORM *); int set_form_page(FORM *form, int n); int form_page(const FORM *form); int field_index(const FIELD *field); </PRE> <H2>DESCRIPTION</H2><PRE> The function <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of the given form; <STRONG>current_field</STRONG> returns the current field of the given form. The function <STRONG>set_form_page</STRONG> sets the form's page number (goes to page <EM>n</EM> of the form). The function <STRONG>form_page</STRONG> returns the form's current page number. The function <STRONG>field_index</STRONG> returns the index of the field in the field array of the form it is connected to. It returns <STRONG>ERR</STRONG> if the argument is the null pointer or the field is not connected. </PRE> <H2>RETURN VALUE</H2><PRE> Except for <STRONG>form_page</STRONG>, each routine returns one of the fol- lowing: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_BAD_ARGUMENT</STRONG> Routine detected an incorrect or out-of-range argu- ment. <STRONG>E_BAD_STATE</STRONG> Routine was called from an initialization or termina- tion function. <STRONG>E_INVALID_FIELD</STRONG> Contents of a field are not valid. <STRONG>E_REQUEST_DENIED</STRONG> The form driver could not process the request. <STRONG>E_SYSTEM_ERROR</STRONG> System error occurred (see <STRONG>errno</STRONG>). </PRE> <H2>SEE ALSO</H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. </PRE> <H2>NOTES</H2><PRE> The header file <STRONG><form.h></STRONG> automatically includes the header file <STRONG><curses.h></STRONG>. </PRE> <H2>PORTABILITY</H2><PRE> These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. </PRE> <H2>AUTHORS</H2><PRE> Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> </PRE> <HR> <ADDRESS> Man(1) output converted with <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> </ADDRESS> </BODY> </HTML>