1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2005,2006 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.14 2006/11/04 17:12:00 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 -->
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>
51 <STRONG>form_field_buffer</STRONG> - field buffer control
55 <H2>SYNOPSIS</H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
57 int set_field_buffer(FIELD *field, int buf, const char
59 char *field_buffer(const FIELD *field, int buffer);
60 int set_field_status(FIELD *field, bool status);
61 bool field_status(const FIELD *field);
62 int set_max_field(FIELD *field, int max);
66 <H2>DESCRIPTION</H2><PRE>
67 The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of
68 the given field to contain a given string. Buffer 0 is
69 the displayed value of the field; other numbered buffers
70 may be allocated by applications through the <STRONG>nbuf</STRONG> argument
71 of (see <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manipulated by the
72 forms library. The function <STRONG>field_buffer</STRONG> returns the
73 address of the buffer. Please note that this buffer has
74 always the length of the buffer, that means that it may
75 typically contain trailing spaces. If you entered leading
76 spaces the buffer may also contain them. If you want the
77 raw data, you must write your own routine that copies the
78 value out of the buffer and removes the leading and trail-
79 ing spaces. Please note also, that subsequent operations
80 on the form will probably change the content of the
81 buffer. So do not use it for long term storage of the
84 The function <STRONG>set_field_status</STRONG> sets the associated status
85 flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current value. The
86 status flag is set to a nonzero value whenever the field
89 The function <STRONG>set_max_field</STRONG> sets the maximum size for a
90 dynamic field. An argument of 0 turns off any maximum
91 size threshold for that field.
95 <H2>RETURN VALUE</H2><PRE>
96 The <STRONG>field_buffer</STRONG> function returns NULL on error. It sets
97 errno according to their success:
99 <STRONG>E_OK</STRONG> The routine succeeded.
101 <STRONG>E_BAD_ARGUMENT</STRONG>
102 Routine detected an incorrect or out-of-range argu-
105 The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
107 The remaining routines return one of the following:
109 <STRONG>E_OK</STRONG> The routine succeeded.
111 <STRONG>E_SYSTEM_ERROR</STRONG>
112 System error occurred (see <STRONG>errno</STRONG>).
114 <STRONG>E_BAD_ARGUMENT</STRONG>
115 Routine detected an incorrect or out-of-range argu-
120 <H2>SEE ALSO</H2><PRE>
121 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
122 detailed descriptions of the entry points.
127 The header file <STRONG><form.h></STRONG> automatically includes the header
130 When configured for wide-characters, <STRONG>field_buffer</STRONG> returns
131 a pointer to temporary storage (allocated and freed by the
132 library). The application should not attempt to modify
133 the data. It will be freed on the next call to
134 <STRONG>field_buffer</STRONG> to return the same buffer. <STRONG><curses.h></STRONG>.
138 <H2>PORTABILITY</H2><PRE>
139 These routines emulate the System V forms library. They
140 were not supported on Version 7 or BSD versions.
144 <H2>AUTHORS</H2><PRE>
145 Juergen Pfeifer. Manual pages and adaptation for new
146 curses by Eric S. Raymond.
150 <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
154 Man(1) output converted with
155 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>