form_page(3) [netbsd man page]

FORM_PAGE(3)						   BSD Library Functions Manual 					      FORM_PAGE(3)

NAME

     current_field, field_index, form_page, form_max_page, set_current_field, set_form_page -- form library

LIBRARY

     Curses Form Library (libform, -lform)

SYNOPSIS

     #include <form.h>

     FIELD *
     current_field(FORM *form);

     int
     field_index(FIELD *field);

     int
     form_page(FORM *form);

     int
     form_max_page(FORM *form);

     int
     set_current_field(FORM *form, FIELD *field);

     int
     set_form_page(FORM *form, int page);

DESCRIPTION

     The current_field() returns a pointer to the structure for the field that is currently active on the page.  If there is an error,
     current_field() will return NULL.	Calling field_index() will return the index of the given field in the form field array.  The current page
     the form is on can be determined by using form_page(), the current page of a form can be programmatically set by calling set_form_page().
     The maximum page number for a form can be found by calling the function form_max_page() but note that this function is a NetBSD extension and
     must not be used in portable forms library programs.  The current field on the form may be set by calling set_current_field() which will set
     the current field to the one given.

RETURN VALUES

     Functions returning pointers will return NULL if an error is detected.  The functions that return an int will return one of the following
     error values:

     E_OK		The function was successful.
     E_BAD_ARGUMENT	The function was passed a bad argument.
     E_NOT_CONNECTED	The given field is not associated with a form.
     E_BAD_STATE	The function was called from within an init or term function.
     E_INVALID_FIELD	The field given is not part of the given form.

SEE ALSO

     curses(3), forms(3)

NOTES

     The header <form.h> automatically includes both <curses.h> and <eti.h>.

     The form_max_page is a NetBSD extension and should not be used in portable applications.

BSD
								  January 1, 2001							       BSD

Check Out this Related Man Page

form_page(3CURSES)					     Curses Library Functions						form_page(3CURSES)

NAME

       form_page, set_form_page, set_current_field, current_field, field_index - set forms current page and field

SYNOPSIS

       cc [ flag... ] file... -lform  -lcurses	[ library... ]
       #include <form.h>

       int set_form_page(FORM *form, int page);

       int form_page(FORM *form);

       int set_current_field(FORM *form, FIELD *field);

       FIELD *current_field(FORM*form);

       int field_index(FIELD *field);

DESCRIPTION

       set_form_page() sets the page number of form to page. form_page() returns the current page number of form.

       set_current_field() sets the current field of form to field. current_field() returns a pointer to the current field of form.

       field_index() returns the index in the field pointer array of field.

RETURN VALUES

       form_page() returns -1 on error.

       current_field() returns NULL on error.

       field_index() returns -1 on error.

       set_form_page() and set_current_field() return one of the following:

       E_OK		   The function returned successfully.

       E_SYSTEM_ERROR	   System error.

       E_BAD_ARGUMENT	   An argument is incorrect.

       E_BAD_STATE	   The routine was called from an      initialization or termination function.

       E_INVALID_FIELD	   The field contents are invalid.

       E_REQUEST_DENIED    The form driver request failed

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

       The header <form.h> automatically includes the headers  <eti.h> and <curses.h>.

SunOS 5.11							    31 Dec 1996 						form_page(3CURSES)

Linux and UNIX Man Pages

form_page(3) [netbsd man page]

Check Out this Related Man Page