X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_info.3x;h=ba4c82a4aecfbc72328fe308906f89c3161f30ec;hp=7ebf5f0dbc928dc20402524faf4c792d47c68e7e;hb=349761f30e7fc0b4bf2718f7fc3da34e09ea6735;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/form_field_info.3x b/man/form_field_info.3x index 7ebf5f0d..ba4c82a4 100644 --- a/man/form_field_info.3x +++ b/man/form_field_info.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2005 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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 * @@ -27,10 +28,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.9 2005/10/08 22:15:07 tom Exp $ +.\" $Id: form_field_info.3x,v 1.17 2020/02/02 23:34:34 tom Exp $ .TH form_field_info 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME -\fBform_field_info\fR - retrieve field characteristics +\fBdynamic_field_info\fP, +\fBfield_info\fR \- retrieve field characteristics .SH SYNOPSIS \fB#include \fR .br @@ -41,45 +47,42 @@ int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *max); .br .SH DESCRIPTION The function \fBfield_info\fR returns the sizes and other attributes passed in -to the field at its creation time. The attributes are: height, width, row of +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\fR returns the actual size of the field, and -its maximum possible size. If the field has no size limit, the location +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\fR option with \fBfield_opts_off\fR. .SH RETURN VALUE These routines return one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .SH SEE ALSO -\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed +\fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.