ncurses 5.6 - patch 20070128
[ncurses.git] / man / form_field_buffer.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_field_buffer.3x,v 1.14 2006/11/04 17:12:00 tom Exp $
31 .TH form_field_buffer 3X ""
32 .SH NAME
33 \fBform_field_buffer\fR - field buffer control
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_field_buffer(FIELD *field, int buf, const char *value);
38 .br
39 char *field_buffer(const FIELD *field, int buffer);
40 .br
41 int set_field_status(FIELD *field, bool status);
42 .br
43 bool field_status(const FIELD *field);
44 .br
45 int set_max_field(FIELD *field, int max);
46 .br
47 .SH DESCRIPTION
48 The function \fBset_field_buffer\fR sets the numbered buffer of the given field
49 to contain a given string.  Buffer 0 is the displayed value of the field; other
50 numbered buffers may be allocated by applications through the \fBnbuf\fR
51 argument of (see \fBform_field_new\fR(3X)) but are not manipulated by the forms
52 library.  The function \fBfield_buffer\fR returns the address of the buffer.
53 Please note that this buffer has always the length of the buffer, that means
54 that it may typically contain trailing spaces. If you entered leading spaces
55 the buffer may also contain them. If you want the raw data, you must write your
56 own routine that copies the value out of the buffer and removes the leading
57 and trailing spaces. Please note also, that subsequent operations on the form
58 will probably change the content of the buffer. So do not use it for long term
59 storage of the entered form data.
60 .PP
61 The function \fBset_field_status\fR sets the associated status flag of
62 \fIfield\fR; \fBfield_status\fR gets the current value.  The status flag
63 is set to a nonzero value whenever the field changes.
64 .PP
65 The function \fBset_max_field\fR sets the maximum size for a dynamic field.
66 An argument of 0 turns off any maximum size threshold for that field.
67 .SH RETURN VALUE
68 The \fBfield_buffer\fR function returns NULL on error.
69 It sets errno according to their success:
70 .TP 5
71 .B E_OK
72 The routine succeeded.
73 .TP 5
74 .B E_BAD_ARGUMENT
75 Routine detected an incorrect or out-of-range argument.
76 .PP
77 The \fBfield_status\fR function returns \fBTRUE\fR or \fBFALSE\fR.
78 .PP
79 The remaining routines return one of the following:
80 .TP 5
81 .B E_OK
82 The routine succeeded.
83 .TP 5
84 .B E_SYSTEM_ERROR
85 System error occurred (see \fBerrno\fR).
86 .TP 5
87 .B E_BAD_ARGUMENT
88 Routine detected an incorrect or out-of-range argument.
89 .SH SEE ALSO
90 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
91 descriptions of the entry points.
92 .SH NOTES
93 The header file \fB<form.h>\fR automatically includes the header file
94 .PP
95 When configured for wide-characters, \fBfield_buffer\fP returns a pointer
96 to temporary storage (allocated and freed by the library).
97 The application should not attempt to modify the data.
98 It will be freed on the next call to \fBfield_buffer\fP to return the
99 same buffer.
100 \fB<curses.h>\fR.
101 .SH PORTABILITY
102 These routines emulate the System V forms library.  They were not supported on
103 Version 7 or BSD versions.
104 .SH AUTHORS
105 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
106 S. Raymond.
107 .\"#
108 .\"# The following sets edit modes for GNU EMACS
109 .\"# Local Variables:
110 .\"# mode:nroff
111 .\"# fill-column:79
112 .\"# End: