d744b16d2313c92313c9cd6c2c50275745bbe446
[ncurses.git] / doc / html / man / form_field_buffer.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2008,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_buffer.3x,v 1.19 2010/12/04 18:38:55 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_buffer 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>form_field_buffer 3x</H1>
43 <HR>
44 <PRE>
45 <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>                             <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
46
47
48
49
50 </PRE>
51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
52        <STRONG>form_field_buffer</STRONG> - field buffer control
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58
59        int  set_field_buffer(FIELD  *field,  int  buf, const char
60        *value);
61        char *field_buffer(const FIELD *field, int buffer);
62        int set_field_status(FIELD *field, bool status);
63        bool field_status(const FIELD *field);
64        int set_max_field(FIELD *field, int max);
65
66
67 </PRE>
68 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69        The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer  of
70        the given field to contain a given string:
71
72           <STRONG>o</STRONG>   Buffer 0 is the displayed value of the field.
73
74           <STRONG>o</STRONG>   Other numbered buffers may be allocated by applica-
75               tions   through   the   <STRONG>nbuf</STRONG>   argument   of   (see
76               <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>)  but are not manipulated by the
77               forms library.
78
79        The function <STRONG>field_buffer</STRONG> returns a pointer  to  the  con-
80        tents of the given numbered buffer:
81
82           <STRONG>o</STRONG>   The  buffer  contents  always have the same length,
83               and are padded with trailing spaces  as  needed  to
84               ensure this length is the same.
85
86           <STRONG>o</STRONG>   The buffer may contain leading spaces, depending on
87               how it was set.
88
89           <STRONG>o</STRONG>   The buffer contents are set with  <STRONG>set_field_buffer</STRONG>,
90               or  as  a  side effect of any editing operations on
91               the corresponding field.
92
93           <STRONG>o</STRONG>   Editing operations are based on  the  <EM>window</EM>  which
94               displays the field, rather than a <EM>string</EM>.  The win-
95               dow contains  only  printable  characters,  and  is
96               filled  with blanks.  If you want the raw data, you
97               must write your own routine that copies  the  value
98               out  of  the  buffer  and  removes  the leading and
99               trailing spaces.
100
101           <STRONG>o</STRONG>   Because editing operations change  the  content  of
102               the  buffer to correspond to the window, you should
103               not rely on using buffers for long-term storage  of
104               form data.
105
106        The  function  <STRONG>set_field_status</STRONG> sets the associated status
107        flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current  value.   The
108        status  flag  is set to a nonzero value whenever the field
109        changes.
110
111        The function <STRONG>set_max_field</STRONG> sets the  maximum  size  for  a
112        dynamic  field.   An  argument  of 0 turns off any maximum
113        size threshold for that field.
114
115
116 </PRE>
117 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
118        The <STRONG>field_buffer</STRONG> function returns NULL on error.  It  sets
119        errno according to their success:
120
121        <STRONG>E_OK</STRONG> The routine succeeded.
122
123        <STRONG>E_BAD_ARGUMENT</STRONG>
124             Routine  detected  an incorrect or out-of-range argu-
125             ment.
126
127        The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
128
129        The remaining routines return one of the following:
130
131        <STRONG>E_OK</STRONG> The routine succeeded.
132
133        <STRONG>E_SYSTEM_ERROR</STRONG>
134             System error occurred (see <STRONG>errno</STRONG>).
135
136        <STRONG>E_BAD_ARGUMENT</STRONG>
137             Routine detected an incorrect or  out-of-range  argu-
138             ment.
139
140
141 </PRE>
142 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
143        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
144        detailed descriptions of the entry points.
145
146
147 </PRE>
148 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
149        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
150        file
151
152        When  configured for wide characters, <STRONG>field_buffer</STRONG> returns
153        a pointer to temporary storage (allocated and freed by the
154        library).   The  application  should not attempt to modify
155        the data.  It will be freed on the next call to <STRONG>field_buf-</STRONG>
156        <STRONG>fer</STRONG> to return the same buffer.  <STRONG>&lt;curses.h&gt;</STRONG>.
157
158
159 </PRE>
160 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
161        These  routines  emulate the System V forms library.  They
162        were not supported on Version 7 or BSD versions.
163
164
165 </PRE>
166 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
167        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
168        curses by Eric S. Raymond.
169
170
171
172                                                   <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
173 </PRE>
174 <div class="nav">
175 <ul>
176 <li><a href="#h2-NAME">NAME</a></li>
177 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
178 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
179 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
180 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
181 <li><a href="#h2-NOTES">NOTES</a></li>
182 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
183 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
184 </ul>
185 </div>
186 </BODY>
187 </HTML>