ncurses 6.2 - patch 20210619
[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.18 2020/10/17 23:35:05 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 <B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B>                                        <B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>dynamic_field_info</B>, <B>field_info</B> - retrieve field characteristics
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;form.h&gt;</B>
56
57        <B>int</B> <B>field_info(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>,</B>
58                       <B>int</B> <B>*</B><I>rows</I><B>,</B> <B>int</B> <B>*</B><I>cols</I><B>,</B>
59                       <B>int</B> <B>*</B><I>frow</I><B>,</B> <B>int</B> <B>*</B><I>fcol</I><B>,</B>
60                       <B>int</B> <B>*</B><I>nrow</I><B>,</B> <B>int</B> <B>*</B><I>nbuf</I><B>);</B>
61
62        <B>int</B> <B>dynamic_field_info(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>,</B>
63                               <B>int</B> <B>*</B><I>rows</I><B>,</B> <B>int</B> <B>*</B><I>cols</I><B>,</B> <B>int</B> <B>*</B><I>max</I><B>);</B>
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        The  function  <B>field_info</B> returns the sizes and other attributes passed
68        in to the field at its creation  time.   The  attributes  are:  height,
69        width,  row  of  upper-left corner, column of upper-left corner, number
70        off-screen rows, and number of working buffers.
71
72        The function <B>dynamic_field_info</B> returns the actual size of  the  field,
73        and  its  maximum  possible  size.  If the field has no size limit, the
74        location addressed by the third argument will be set to 0.  A field can
75        be made dynamic by turning off the <B>O_STATIC</B> option with <B>field_opts_off</B>.
76
77
78 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
79        These routines return one of the following:
80
81        <B>E_OK</B> The routine succeeded.
82
83        <B>E_SYSTEM_ERROR</B>
84             System error occurred (see <B>errno(3)</B>).
85
86        <B>E_BAD_ARGUMENT</B>
87             Routine detected an incorrect or out-of-range argument.
88
89
90 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
91        <B><A HREF="curses.3X.html">curses(3X)</A></B>  and  related  pages  whose names begin "form_" for detailed
92        descriptions of the entry points.
93
94
95 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
96        The  header  file  <B>&lt;form.h&gt;</B>  automatically  includes  the  header  file
97        <B>&lt;curses.h&gt;</B>.
98
99
100 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
101        These  routines  emulate  the  System  V  forms library.  They were not
102        supported on Version 7 or BSD versions.
103
104        A null (zero pointer) is accepted for any  of  the  return  values,  to
105        ignore  that  value.  Not all implementations allow this, e.g., Solaris
106        2.7 does not.
107
108
109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
110        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
111        Raymond.
112
113
114
115                                                            <B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B>
116 </PRE>
117 <div class="nav">
118 <ul>
119 <li><a href="#h2-NAME">NAME</a></li>
120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
127 </ul>
128 </div>
129 </BODY>
130 </HTML>