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