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