Ada95/html/man/form_page.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4        <STRONG>form_page</STRONG> - set and get form page number
   5
   6
   7 </PRE>
   8 <H2>SYNOPSIS</H2><PRE>
   9        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
  10        int set_current_field(FORM *form, FIELD *field);
  11        FIELD *current_field(const FORM *);
  12        int set_form_page(FORM *form, int n);
  13        int form_page(const FORM *form);
  14        int field_index(const FIELD *field);
  15
  16
  17 </PRE>
  18 <H2>DESCRIPTION</H2><PRE>
  19        The  function  <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
  20        the given form; <STRONG>current_field</STRONG> returns the current field of
  21        the given form.
  22
  23        The  function  <STRONG>set_form_page</STRONG>  sets  the form's page number
  24        (goes to page <EM>n</EM> of the form).
  25
  26        The function <STRONG>form_page</STRONG> returns  the  form's  current  page
  27        number.
  28
  29        The function <STRONG>field_index</STRONG> returns the index of the field in
  30        the field array of the form it is connected to. It returns
  31        <STRONG>ERR</STRONG>  if  the  argument is the null pointer or the field is
  32        not connected.
  33
  34
  35 </PRE>
  36 <H2>RETURN VALUE</H2><PRE>
  37        Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
  38        lowing:
  39
  40        <STRONG>E_OK</STRONG> The routine succeeded.
  41
  42        <STRONG>E_SYSTEM_ERROR</STRONG>
  43             System error occurred (see <STRONG>errno</STRONG>).
  44
  45        <STRONG>E_BAD_ARGUMENT</STRONG>
  46             Routine  detected  an incorrect or out-of-range argu-
  47             ment.
  48
  49        <STRONG>E_BAD_STATE</STRONG>
  50             Routine was called from an initialization or termina-
  51             tion function.
  52
  53        <STRONG>E_INVALID_FIELD</STRONG>
  54             Contents of a field are not valid.
  55
  56        <STRONG>E_REQUEST_DENIED</STRONG>
  57             The form driver could not process the request.
  58
  59
  60 </PRE>
  61 <H2>SEE ALSO</H2><PRE>
  62        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
  63
  64        The header file <STRONG><form.h></STRONG> automatically includes the header
  65        file <STRONG><curses.h></STRONG>.
  66
  67
  68 </PRE>
  69 <H2>PORTABILITY</H2><PRE>
  70        These routines emulate the System V forms  library.   They
  71        were not supported on Version 7 or BSD versions.
  72
  73
  74 </PRE>
  75 <H2>AUTHORS</H2><PRE>
  76        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  77        curses by Eric S. Raymond.
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120 </PRE>
 121 </BODY>
 122 </HTML>