xref: /illumos-gate/usr/src/man/man3curses/form_field_new.3curses (revision d8e10381a0083d7717710b0db7e64707bc0f3ff8)
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_NEW 3CURSES "Dec 31, 1996"
NAME
form_field_new, new_field, dup_field, link_field, free_field - create and destroy forms fields
SYNOPSIS

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

FIELD *new_field(int r, int c, int frow, int fcol, int nrow, int ncol);

FIELD *dup_field(FIELD *field, int frow, int fcol);

FIELD *link_field(FIELD *field, int frow, int fcol);

int free_field(FIELD *field);
DESCRIPTION

new_field() creates a new field with r rows and c columns, starting at frow, fcol, in the subwindow of a form. nrow is the number of off-screen rows and nbuf is the number of additional working buffers. This routine returns a pointer to the new field.

dup_field() duplicates field at the specified location. All field attributes are duplicated, including the current contents of the field buffers.

link_field() also duplicates field at the specified location. However, unlike dup_field(), the new field shares the field buffers with the original field. After creation, the attributes of the new field can be changed without affecting the original field.

free_field() frees the storage allocated for field.

RETURN VALUES

Routines that return pointers return NULL on error. free_field() returns 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.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

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

NOTES

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