'\" t
.\"***************************************************************************
-.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. *
+.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_field_buffer.3x,v 1.15 2008/10/18 18:35:17 tom Exp $
+.\" $Id: form_field_buffer.3x,v 1.16 2010/07/31 16:09:36 tom Exp $
.TH form_field_buffer 3X ""
.SH NAME
-\fBform_field_buffer\fR - field buffer control
+\fBform_field_buffer\fR \- field buffer control
.SH SYNOPSIS
\fB#include <form.h>\fR
.br
to contain a given string:
.RS 3
.TP 3
--
+\-
Buffer 0 is the displayed value of the field.
.TP 3
--
+\-
Other numbered buffers may be allocated by applications through the \fBnbuf\fR
argument of (see \fBform_field_new\fR(3X))
but are not manipulated by the forms library.
the contents of the given numbered buffer:
.RS 3
.TP 3
--
+\-
The buffer contents always have the same length,
and are padded with trailing spaces
as needed to ensure this length is the same.
.TP 3
--
+\-
The buffer may contain leading spaces, depending on how it was set.
.TP 3
--
+\-
The buffer contents are set with \fBset_field_buffer\fP,
or as a side effect of any editing operations on the corresponding field.
.TP 3
--
+\-
Editing operations are based on the \fIwindow\fP which displays the field,
rather than a \fIstring\fP.
The window contains only printable characters, and is filled with blanks.
own routine that copies the value out of the buffer and removes the leading
and trailing spaces.
.TP 3
--
+\-
Because editing operations change the content of the buffer to
correspond to the window, you should not rely on using buffers
for long-term storage of form data.