set_form_page(3x)

1form_page(3X)                                                    form_page(3X)
2
3
4

NAME

6       form_page - set and get form page number
7

SYNOPSIS

9       #include <form.h>
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

DESCRIPTION

17       The  function  set_current  field  sets  the current field of the given
18       form; current_field returns the current field of the given form.
19
20       The function set_form_page sets the form's page number (goes to page  n
21       of the form).
22
23       The function form_page returns the form's current page number.
24
25       The  function  field_index  returns the index of the field in the field
26       array of the form it is connected to. It returns ERR if the argument is
27       the null pointer or the field is not connected.
28

RETURN VALUE

30       Except for form_page, each routine returns one of the following:
31
32       E_OK The routine succeeded.
33
34       E_BAD_ARGUMENT
35            Routine detected an incorrect or out-of-range argument.
36
37       E_BAD_STATE
38            Routine was called from an initialization or termination function.
39
40       E_INVALID_FIELD
41            Contents of a field are not valid.
42
43       E_REQUEST_DENIED
44            The form driver could not process the request.
45
46       E_SYSTEM_ERROR
47            System error occurred (see errno).
48

NOTES

53       The  header  file  <form.h>  automatically  includes  the  header  file
54       <curses.h>.
55

PORTABILITY

57       These routines emulate the System V forms library.  They were not  sup‐
58       ported on Version 7 or BSD versions.
59

AUTHORS

61       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
62       Raymond.
63
64
65
66                                                                 form_page(3X)