ncurses 5.7 - patch 20100109
[ncurses.git] / doc / html / man / form_field_buffer.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_field_buffer.3x,v 1.15 2008/10/18 18:35:17 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
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">
38 </HEAD>
39 <BODY>
40 <H1>form_field_buffer 3x</H1>
41 <HR>
42 <PRE>
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>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>form_field_buffer</STRONG> - field buffer control
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        int  set_field_buffer(FIELD  *field,  int  buf, const char
58        *value);
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);
63
64
65 </PRE>
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:
69
70           -  Buffer 0 is the displayed value of the field.
71
72           -  Other  numbered buffers may be allocated by applica-
73              tions   through   the   <STRONG>nbuf</STRONG>   argument   of    (see
74              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>)  but  are not manipulated by the
75              forms library.
76
77        The function <STRONG>field_buffer</STRONG> returns a pointer  to  the  con-
78        tents of the given numbered buffer:
79
80           -  The buffer contents always have the same length, and
81              are padded with trailing spaces as needed to  ensure
82              this length is the same.
83
84           -  The  buffer may contain leading spaces, depending on
85              how it was set.
86
87           -  The buffer contents are set  with  <STRONG>set_field_buffer</STRONG>,
88              or as a side effect of any editing operations on the
89              corresponding field.
90
91           -  Editing operations are based  on  the  <EM>window</EM>  which
92              displays  the field, rather than a <EM>string</EM>.  The win-
93              dow  contains  only  printable  characters,  and  is
94              filled  with  blanks.  If you want the raw data, you
95              must write your own routine that  copies  the  value
96              out of the buffer and removes the leading and trail-
97              ing spaces.
98
99           -  Because editing operations change the content of the
100              buffer  to  correspond to the window, you should not
101              rely on using buffers for long-term storage of  form
102              data.
103
104        The  function  <STRONG>set_field_status</STRONG> sets the associated status
105        flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current  value.   The
106        status  flag  is set to a nonzero value whenever the field
107        changes.
108
109        The function <STRONG>set_max_field</STRONG> sets the  maximum  size  for  a
110        dynamic  field.   An  argument  of 0 turns off any maximum
111        size threshold for that field.
112
113
114 </PRE>
115 <H2>RETURN VALUE</H2><PRE>
116        The <STRONG>field_buffer</STRONG> function returns NULL on error.  It  sets
117        errno according to their success:
118
119        <STRONG>E_OK</STRONG> The routine succeeded.
120
121        <STRONG>E_BAD_ARGUMENT</STRONG>
122             Routine  detected  an incorrect or out-of-range argu-
123             ment.
124
125        The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
126
127        The remaining routines return one of the following:
128
129        <STRONG>E_OK</STRONG> The routine succeeded.
130
131        <STRONG>E_SYSTEM_ERROR</STRONG>
132             System error occurred (see <STRONG>errno</STRONG>).
133
134        <STRONG>E_BAD_ARGUMENT</STRONG>
135             Routine detected an incorrect or  out-of-range  argu-
136             ment.
137
138
139 </PRE>
140 <H2>SEE ALSO</H2><PRE>
141        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
142        detailed descriptions of the entry points.
143
144
145 </PRE>
146 <H2>NOTES</H2><PRE>
147        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
148        file
149
150        When  configured for wide-characters, <STRONG>field_buffer</STRONG> returns
151        a pointer to temporary storage (allocated and freed by the
152        library).   The  application  should not attempt to modify
153        the data.  It will be freed on the next call to <STRONG>field_buf-</STRONG>
154        <STRONG>fer</STRONG> to return the same buffer.  <STRONG>&lt;curses.h&gt;</STRONG>.
155
156
157 </PRE>
158 <H2>PORTABILITY</H2><PRE>
159        These  routines  emulate the System V forms library.  They
160        were not supported on Version 7 or BSD versions.
161
162
163 </PRE>
164 <H2>AUTHORS</H2><PRE>
165        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
166        curses by Eric S. Raymond.
167
168
169
170                                                   <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
171 </PRE>
172 <HR>
173 <ADDRESS>
174 Man(1) output converted with
175 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
176 </ADDRESS>
177 </BODY>
178 </HTML>