3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: form_field_buffer.3x,v 1.25 2020/02/02 23:34:34 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_buffer 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">
43 <H1 class="no-header">form_field_buffer 3x</H1>
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>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_field_buffer</STRONG> - field buffer control
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 int set_field_buffer(FIELD *field, int buf, const char *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);
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of the given
66 field to contain a given string:
68 <STRONG>o</STRONG> Buffer 0 is the displayed value of the field.
70 <STRONG>o</STRONG> Other numbered buffers may be allocated by applications through
71 the <STRONG>nbuf</STRONG> argument of (see <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manip-
72 ulated by the forms library.
74 The function <STRONG>field_buffer</STRONG> returns a pointer to the contents of the
75 given numbered buffer:
77 <STRONG>o</STRONG> The buffer contents always have the same length, and are padded
78 with trailing spaces as needed to ensure this length is the
81 <STRONG>o</STRONG> The buffer may contain leading spaces, depending on how it was
84 <STRONG>o</STRONG> The buffer contents are set with <STRONG>set_field_buffer</STRONG>, or as a side
85 effect of any editing operations on the corresponding field.
87 <STRONG>o</STRONG> Editing operations are based on the <EM>window</EM> which displays the
88 field, rather than a <EM>string</EM>. The window contains only printable
89 characters, and is filled with blanks. If you want the raw
90 data, you must write your own routine that copies the value out
91 of the buffer and removes the leading and trailing spaces.
93 <STRONG>o</STRONG> Because editing operations change the content of the buffer to
94 correspond to the window, you should not rely on using buffers
95 for long-term storage of form data.
97 The function <STRONG>set_field_status</STRONG> sets the associated status flag of <EM>field</EM>;
98 <STRONG>field_status</STRONG> gets the current value. The status flag is set to a
99 nonzero value whenever the field changes.
101 The function <STRONG>set_max_field</STRONG> sets the maximum size for a dynamic field.
102 An argument of 0 turns off any maximum size threshold for that field.
105 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
106 The <STRONG>field_buffer</STRONG> function returns NULL on error. It sets errno accord-
107 ing to their success:
109 <STRONG>E_OK</STRONG> The routine succeeded.
111 <STRONG>E_BAD_ARGUMENT</STRONG>
112 Routine detected an incorrect or out-of-range argument.
114 The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
116 The remaining routines return one of the following:
118 <STRONG>E_OK</STRONG> The routine succeeded.
120 <STRONG>E_SYSTEM_ERROR</STRONG>
121 System error occurred (see <STRONG>errno(3)</STRONG>).
123 <STRONG>E_BAD_ARGUMENT</STRONG>
124 Routine detected an incorrect or out-of-range argument.
127 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
128 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for detailed
129 descriptions of the entry points.
132 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
133 The header file <STRONG><form.h></STRONG> automatically includes the header file
135 When configured for wide characters, <STRONG>field_buffer</STRONG> returns a pointer to
136 temporary storage (allocated and freed by the library). The applica-
137 tion should not attempt to modify the data. It will be freed on the
138 next call to <STRONG>field_buffer</STRONG> to return the same buffer. <STRONG><curses.h></STRONG>.
141 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
142 These routines emulate the System V forms library. They were not sup-
143 ported on Version 7 or BSD versions.
145 The <STRONG>set_max_field</STRONG> function checks for an ncurses extension
146 <STRONG>O_INPUT_FIELD</STRONG> which allows a dynamic field to shrink if the new limit
147 is smaller than the current field size.
150 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
151 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
156 <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
160 <li><a href="#h2-NAME">NAME</a></li>
161 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
162 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
163 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
164 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
165 <li><a href="#h2-NOTES">NOTES</a></li>
166 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
167 <li><a href="#h2-AUTHORS">AUTHORS</a></li>