| .\"*************************************************************************** |
| .\" Copyright 2018-2023,2024 Thomas E. Dickey * |
| .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * |
| .\" * |
| .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| .\" copy of this software and associated documentation files (the * |
| .\" "Software"), to deal in the Software without restriction, including * |
| .\" without limitation the rights to use, copy, modify, merge, publish, * |
| .\" distribute, distribute with modifications, sublicense, and/or sell * |
| .\" copies of the Software, and to permit persons to whom the Software is * |
| .\" furnished to do so, subject to the following conditions: * |
| .\" * |
| .\" The above copyright notice and this permission notice shall be included * |
| .\" in all copies or substantial portions of the Software. * |
| .\" * |
| .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| .\" * |
| .\" Except as contained in this notice, the name(s) of the above copyright * |
| .\" holders shall not be used in advertising or otherwise to promote the * |
| .\" sale, use or other dealings in this Software without prior written * |
| .\" authorization. * |
| .\"*************************************************************************** |
| .\" |
| .\" $Id: form_field_info.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ |
| .TH form_field_info 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" |
| .ie \n(.g \{\ |
| .ds `` \(lq |
| .ds '' \(rq |
| .\} |
| .el \{\ |
| .ie t .ds `` `` |
| .el .ds `` "" |
| .ie t .ds '' '' |
| .el .ds '' "" |
| .\} |
| .SH NAME |
| \fBdynamic_field_info\fP, |
| \fBfield_info\fP \- |
| retrieve field characteristics |
| .SH SYNOPSIS |
| .nf |
| \fB#include <form.h> |
| .PP |
| \fBint field_info(const FIELD *\fIfield\fP, |
| \fBint *\fIrows\fB, int *\fIcols\fB,\fR |
| \fBint *\fIfrow\fB, int *\fIfcol\fB,\fR |
| \fBint *\fInrow\fB, int *\fInbuf\fB);\fR |
| .PP |
| \fBint dynamic_field_info(const FIELD *\fIfield\fB,\fR |
| \fBint *\fIrows\fB, int *\fIcols\fB, int *\fImax\fB);\fR |
| .fi |
| .SH DESCRIPTION |
| The function \fBfield_info\fP returns the sizes and other attributes passed in |
| to the field at its creation time. |
| The attributes are: height, width, row of |
| upper-left corner, column of upper-left corner, number off-screen rows, and |
| number of working buffers. |
| .PP |
| The function \fBdynamic_field_info\fP returns the actual size of the field, and |
| its maximum possible size. |
| If the field has no size limit, the location |
| addressed by the third argument will be set to 0. |
| A field can be made dynamic |
| by turning off the \fBO_STATIC\fP option with \fBfield_opts_off\fP. |
| .SH RETURN VALUE |
| These routines return one of the following: |
| .TP 5 |
| .B E_OK |
| The routine succeeded. |
| .TP 5 |
| .B E_SYSTEM_ERROR |
| System error occurred (see \fBerrno\fP(3)). |
| .TP 5 |
| .B E_BAD_ARGUMENT |
| Routine detected an incorrect or out-of-range argument. |
| .SH PORTABILITY |
| These routines emulate the System V forms library. |
| They were not supported on |
| Version 7 or BSD versions. |
| .PP |
| A null (zero pointer) is accepted for any of the return values, |
| to ignore that value. |
| Not all implementations allow this, e.g., Solaris 2.7 does not. |
| .SH AUTHORS |
| Juergen Pfeifer. |
| Manual pages and adaptation for new curses by Eric S. Raymond. |
| .SH SEE ALSO |
| \fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' |
| for detailed descriptions of the entry points. |