ncurses 4.1
[ncurses.git] / man / form_field_info.3x
1 '\" t
2 .TH form_field_info 3X ""
3 .SH NAME
4 \fBform_field_info\fR - retrieve field characteristics
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int field_info(const FIELD *field, int *rows, int *cols,
9               int *frow, int *fcol, int *nrow, int *nbuf);
10 .br
11 int dynamic_field_info(const FIELD *field, int *rows, int *cols, *max);
12 .br
13 .SH DESCRIPTION
14 The function \fBfield_info\fR returns the sizes and other attributes passed in
15 to the field at its creation time.  The attributes are: height, width, row of
16 upper-left corner, column of upper-left corner, number off-screen rows, and
17 number of working buffers.
18
19 The function \fBdynamic_field_info\fR returns the actual size of the field, and
20 its maximum possible size.  If the field has no size limit, the location
21 addressed by the third argument will be set to 0.  (A field can be made dynamic
22 by turning off the \fBO_STATIC\fR).
23 .SH RETURN VALUE
24 These routines return one of the following:
25 .TP 5
26 \fBE_OK\fR
27 The routine succeeded.
28 .TP 5
29 \fBE_SYSTEM_ERROR\fR
30 System error occurred (see \fBerrno\fR).
31 .TP 5
32 \fBE_BAD_ARGUMENT\fR
33 Routine detected an incorrect or out-of-range argument.
34 .SH SEE ALSO
35 \fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
36 descriptions of the entry points.
37 .SH NOTES
38 The header file \fB<form.h>\fR automatically includes the header file
39 \fB<curses.h>\fR.
40 .SH PORTABILITY
41 These routines emulate the System V forms library.  They were not supported on
42 Version 7 or BSD versions.
43 .SH AUTHORS
44 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
45 S. Raymond.
46 .\"#
47 .\"# The following sets edit modes for GNU EMACS
48 .\"# Local Variables:
49 .\"# mode:nroff
50 .\"# fill-column:79
51 .\"# End: