xref: /illumos-gate/usr/src/man/man3curses/form_field_info.3curses (revision b30d193948be5a7794d7ae3ba0ed9c2f72c88e0f)
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_INFO 3CURSES "Dec 31, 1996"
NAME
form_field_info, field_info, dynamic_field_info - get forms field characteristics
SYNOPSIS

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

int field_info(FIELD *field, int *rows, int *cols, int *frow, int *fcol,
 int *nrow, int *nbuf);

int dynamic_field_info(FIELD *field, int *drows, int *dcols, int *max);
DESCRIPTION

field_info() returns the size, position, and other named field characteristics, as defined in the original call to new_field(), to the locations pointed to by the arguments rows, cols, frow, fcol, nrow, and nbuf.

dynamic_field_info() returns the actual size of the field in the pointer arguments drows, dcols and returns the maximum growth allowed for field in max. If no maximum growth limit is specified for field, max will contain 0. A field can be made dynamic by turning off the field option O_STATIC.

RETURN VALUES

These routines return one of the following: E_OK

The function returned successfully.

E_SYSTEM_ERROR

System error.

E_BAD_ARGUMENT

An argument is incorrect.

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