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