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