xref: /illumos-gate/usr/src/man/man3curses/form_page.3curses (revision 7e3dbbac48aaad67ac841ba479a67a2081d6a02b)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
FORM_PAGE 3CURSES "Dec 31, 1996"
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>.