1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998,2002 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.9 2002/01/19 22:48:23 tom Exp @
35 <TITLE>form_field_buffer 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 <H1>form_field_buffer 3x</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
47 <STRONG>form_field_buffer</STRONG> - field buffer control
51 <H2>SYNOPSIS</H2><PRE>
52 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
53 int set_field_buffer(FIELD *field, int buf, const char
55 char *field_buffer(const FIELD *field, int buffer);
56 int set_field_status(FIELD *field, bool status);
57 bool field_status(const FIELD *field);
58 int set_max_field(FIELD *field, int max);
62 <H2>DESCRIPTION</H2><PRE>
63 The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of
64 the given field to contain a given string. Buffer 0 is
65 the displayed value of the field; other numbered buffers
66 may be allocated by applications through the <STRONG>nbuf</STRONG> argument
67 of (see <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manipulated by the
68 forms library. The function <STRONG>field_buffer</STRONG> returns the
69 address of the buffer. Please note that this buffer has
70 always the length of the buffer, that means that it may
71 typically contain trailing spaces. If you entered leading
72 spaces the buffer may also contain them. If you want the
73 raw data, you must write your own routine that copies the
74 value out of the buffer and removes the leading and trail-
75 ing spaces. Please note also, that subsequent operations
76 on the form will probably change the content of the
77 buffer. So don't use it for long term storage of the
80 The function <STRONG>set_field_status</STRONG> sets the associated status
81 flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current value. The
82 status flag is set to a nonzero value whenever the field
85 The function <STRONG>set_max_field</STRONG> sets the maximum size for a
86 dynamic field. An argument of 0 turns off any maximum
87 size threshold for that field.
91 <H2>RETURN VALUE</H2><PRE>
92 The <STRONG>field_buffer</STRONG> function returns NULL on error.
94 The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
96 The remaining routines return one of the following:
98 <STRONG>E_OK</STRONG> The routine succeeded.
100 <STRONG>E_SYSTEM_ERROR</STRONG>
101 System error occurred (see <STRONG>errno</STRONG>).
103 <STRONG>E_BAD_ARGUMENT</STRONG>
104 Routine detected an incorrect or out-of-range argu-
109 <H2>SEE ALSO</H2><PRE>
110 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
111 detailed descriptions of the entry points.
116 The header file <STRONG><form.h></STRONG> automatically includes the header
117 file <STRONG><curses.h></STRONG>.
121 <H2>PORTABILITY</H2><PRE>
122 These routines emulate the System V forms library. They
123 were not supported on Version 7 or BSD versions.
127 <H2>AUTHORS</H2><PRE>
128 Juergen Pfeifer. Manual pages and adaptation for new
129 curses by Eric S. Raymond.
172 Man(1) output converted with
173 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>