form_field()

NAME

set_form_fields(), form_fields, field_count(), move_field() - make and break connections between fields and forms

SYNOPSIS

#include <form.h>


int set_form_fields(FORM *form, FIELD **fields);
FIELD **form_fields(FORM *form);
int field_count(FORM *form);
int move_field(FIELD *field, int frow, int fcol);

DESCRIPTION

The function set_form_fields(3) changes the field pointer array of the given form. The array must be terminated by a NULL.

The function form_fields(3) returns the field array of the given form.

The function field_count(3) returns the count of fields in form.

The function move_field(3) move the given field (which must be disconnected) to a specified location on the screen.

RETURN VALUES

The function form_fields(3) returns NULL on error.

The function field_count(3) returns ERR (the general curses error return value) on error.

The functions set_form_fields(3) and move_field(3) return one of the following codes on error:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno

E_BAD_ARGUMENT

Routine detected an incorrect or out-of-range argument.

E_POSTED

The form is already posted.

E_CONNECTED

The field is already connected to a form.

SEE ALSO

curses(3)

forms(3)

NOTES

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

PORTABILITY

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.

The SVr4 forms library documentation specifies the field_count(3) error value as -1 (which is the value of ERR).