ncurses 5.1
[ncurses.git] / doc / html / man / form_field_info.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>form_field_info</B> - retrieve field characteristics
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;form.h&gt;</B>
14        int field_info(const FIELD *field, int *rows, int *cols,
15                      int *frow, int *fcol, int *nrow, int *nbuf);
16        int dynamic_field_info(const FIELD *field, int *rows,  int
17        *cols, *max);
18
19
20 </PRE>
21 <H2>DESCRIPTION</H2><PRE>
22        The  function  <B>field_info</B>  returns  the  sizes  and  other
23        attributes passed in to the field at  its  creation  time.
24        The  attributes are: height, width, row of upper-left cor-
25        ner, column of upper-left corner, number off-screen  rows,
26        and number of working buffers.
27
28        The function <B>dynamic_field_info</B> returns the actual size of
29        the field, and its maximum possible size.   If  the  field
30        has  no  size  limit,  the location addressed by the third
31        argument will be set to 0.  (A field can be  made  dynamic
32        by turning off the <B>O_STATIC</B>).
33
34
35 </PRE>
36 <H2>RETURN VALUE</H2><PRE>
37        These routines return one of the following:
38
39        <B>E_OK</B> The routine succeeded.
40
41        <B>E_SYSTEM_ERROR</B>
42             System error occurred (see <B>errno</B>).
43
44        <B>E_BAD_ARGUMENT</B>
45             Routine  detected  an incorrect or out-of-range argu-
46             ment.
47
48
49 </PRE>
50 <H2>SEE ALSO</H2><PRE>
51        <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages  whose  names  begin  "form_"  for
52        detailed descriptions of the entry points.
53
54
55 </PRE>
56 <H2>NOTES</H2><PRE>
57        The header file <B>&lt;form.h&gt;</B> automatically includes the header
58        file <B>&lt;curses.h&gt;</B>.
59
60
61 </PRE>
62 <H2>PORTABILITY</H2><PRE>
63        These routines emulate the System V forms  library.   They
64        were not supported on Version 7 or BSD versions.
65
66        A  null  (zero  pointer) is accepted for any of the return
67        values, to ignore that  value.   Not  all  implementations
68        allow this, e.g., Solaris 2.7 does not.
69
70
71 </PRE>
72 <H2>AUTHORS</H2><PRE>
73        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
74        curses by Eric S. Raymond.
75 </PRE>
76 <HR>
77 <ADDRESS>
78 Man(1) output converted with
79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
80 </ADDRESS>
81 </BODY>
82 </HTML>