ncurses 6.1 - patch 20181208
[ncurses.git] / man / form_field_buffer.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2017,2018 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.21 2018/07/28 21:34:06 tom Exp $
31 .TH form_field_buffer 3X ""
32 .de bP
33 .ie n  .IP \(bu 4
34 .el    .IP \(bu 2
35 ..
36 .SH NAME
37 \fBform_field_buffer\fR \- field buffer control
38 .SH SYNOPSIS
39 \fB#include <form.h>\fR
40 .sp
41 int set_field_buffer(FIELD *field, int buf, const char *value);
42 .br
43 char *field_buffer(const FIELD *field, int buffer);
44 .br
45 int set_field_status(FIELD *field, bool status);
46 .br
47 bool field_status(const FIELD *field);
48 .br
49 int set_max_field(FIELD *field, int max);
50 .br
51 .SH DESCRIPTION
52 The function \fBset_field_buffer\fR sets the numbered buffer of the given field
53 to contain a given string:
54 .RS 3
55 .bP
56 Buffer 0 is the displayed value of the field.
57 .bP
58 Other numbered buffers may be allocated by applications through the \fBnbuf\fR
59 argument of (see \fBform_field_new\fR(3X))
60 but are not manipulated by the forms library.
61 .RE
62 .PP
63 The function \fBfield_buffer\fR returns a pointer to
64 the contents of the given numbered buffer:
65 .RS 3
66 .bP
67 The buffer contents always have the same length,
68 and are padded with trailing spaces
69 as needed to ensure this length is the same.
70 .bP
71 The buffer may contain leading spaces, depending on how it was set.
72 .bP
73 The buffer contents are set with \fBset_field_buffer\fP,
74 or as a side effect of any editing operations on the corresponding field.
75 .bP
76 Editing operations are based on the \fIwindow\fP which displays the field,
77 rather than a \fIstring\fP.
78 The window contains only printable characters, and is filled with blanks.
79 If you want the raw data, you must write your
80 own routine that copies the value out of the buffer and removes the leading
81 and trailing spaces.
82 .bP
83 Because editing operations change the content of the buffer to
84 correspond to the window, you should not rely on using buffers
85 for long-term storage of form data.
86 .RE
87 .PP
88 The function \fBset_field_status\fR sets the associated status flag of
89 \fIfield\fR; \fBfield_status\fR gets the current value.
90 The status flag
91 is set to a nonzero value whenever the field changes.
92 .PP
93 The function \fBset_max_field\fR sets the maximum size for a dynamic field.
94 An argument of 0 turns off any maximum size threshold for that field.
95 .SH RETURN VALUE
96 The \fBfield_buffer\fR function returns NULL on error.
97 It sets errno according to their success:
98 .TP 5
99 .B E_OK
100 The routine succeeded.
101 .TP 5
102 .B E_BAD_ARGUMENT
103 Routine detected an incorrect or out-of-range argument.
104 .PP
105 The \fBfield_status\fR function returns \fBTRUE\fR or \fBFALSE\fR.
106 .PP
107 The remaining routines return one of the following:
108 .TP 5
109 .B E_OK
110 The routine succeeded.
111 .TP 5
112 .B E_SYSTEM_ERROR
113 System error occurred (see \fBerrno\fR).
114 .TP 5
115 .B E_BAD_ARGUMENT
116 Routine detected an incorrect or out-of-range argument.
117 .SH SEE ALSO
118 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
119 descriptions of the entry points.
120 .SH NOTES
121 The header file \fB<form.h>\fR automatically includes the header file
122 .PP
123 When configured for wide characters, \fBfield_buffer\fP returns a pointer
124 to temporary storage (allocated and freed by the library).
125 The application should not attempt to modify the data.
126 It will be freed on the next call to \fBfield_buffer\fP to return the
127 same buffer.
128 \fB<curses.h>\fR.
129 .SH PORTABILITY
130 These routines emulate the System V forms library.
131 They were not supported on
132 Version 7 or BSD versions.
133 .SH AUTHORS
134 Juergen Pfeifer.
135 Manual pages and adaptation for new curses by Eric S. Raymond.