ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_field_info.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_info.3x,v 1.17 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_field_info 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_field_info 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>                                        <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>dynamic_field_info</STRONG>, <STRONG>field_info</STRONG> - retrieve field characteristics
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56        int field_info(const FIELD *field, int *rows, int *cols,
57                      int *frow, int *fcol, int *nrow, int *nbuf);
58        int  dynamic_field_info(const  FIELD  *field, int *rows, int *cols, int
59        *max);
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>field_info</STRONG> returns the sizes and other  attributes  passed
64        in  to  the  field  at  its creation time.  The attributes are: height,
65        width, row of upper-left corner, column of  upper-left  corner,  number
66        off-screen rows, and number of working buffers.
67
68        The  function  <STRONG>dynamic_field_info</STRONG> returns the actual size of the field,
69        and its maximum possible size.  If the field has  no  size  limit,  the
70        location addressed by the third argument will be set to 0.  A field can
71        be made dynamic by turning off the <STRONG>O_STATIC</STRONG> option with <STRONG>field_opts_off</STRONG>.
72
73
74 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
75        These routines return one of the following:
76
77        <STRONG>E_OK</STRONG> The routine succeeded.
78
79        <STRONG>E_SYSTEM_ERROR</STRONG>
80             System error occurred (see <STRONG>errno(3)</STRONG>).
81
82        <STRONG>E_BAD_ARGUMENT</STRONG>
83             Routine detected an incorrect or out-of-range argument.
84
85
86 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
87        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names  begin  "form_"  for  detailed
88        descriptions of the entry points.
89
90
91 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
92        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
93        <STRONG>&lt;curses.h&gt;</STRONG>.
94
95
96 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
97        These routines emulate the System V forms library.  They were not  sup-
98        ported on Version 7 or BSD versions.
99
100        A  null  (zero  pointer)  is  accepted for any of the return values, to
101        ignore that value.  Not all implementations allow this,  e.g.,  Solaris
102        2.7 does not.
103
104
105 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
106        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
107        Raymond.
108
109
110
111                                                            <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
112 </PRE>
113 <div class="nav">
114 <ul>
115 <li><a href="#h2-NAME">NAME</a></li>
116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>