xref: /illumos-gate/usr/src/man/man3curses/form_field.3curses (revision cd61ae21816e53b94bc1673f3f1aa651fc3115e8)
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_FIELD 3CURSES "Dec 31, 1996"
NAME
form_field, set_form_fields, form_fields, field_count, move_field - connect fields to forms
SYNOPSIS

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

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

FIELD **form_fields(FORM *form);

int field_count(FORM *form);

int move_field(FIELD *field, int frow, int fcol);
DESCRIPTION

set_form_fields() changes the fields connected to form to fields. The original fields are disconnected.

form_fields() returns a pointer to the field pointer array connected to form.

field_count() returns the number of fields connected to form.

move_field() moves the disconnected field to the location frow, fcol in the forms subwindow.

RETURN VALUES

form_fields() returns NULL on error.

field_count() returns -1 on error.

set_form_fields() and move_field() return one of the following: E_OK

The function returned successfully.

E_CONNECTED

The field is already connected to a form.

E_SYSTEM_ERROR

System error.

E_BAD_ARGUMENT

An argument is incorrect

E_POSTED

The form is posted.

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>.