X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_buffer.3x;h=9eea9982e053b3b738cc3c42aa2baacd5d33cd87;hp=566072f55ddb29f021ff716a26258a1800089605;hb=d448186ac240901c6976dc74c260f052d3ed53e4;hpb=b5df67bc6814f67b5562171c53e3720a30819bba diff --git a/man/form_field_buffer.3x b/man/form_field_buffer.3x index 566072f5..9eea9982 100644 --- a/man/form_field_buffer.3x +++ b/man/form_field_buffer.3x @@ -1,6 +1,6 @@ '\" 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 * @@ -27,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_buffer.3x,v 1.15 2008/10/18 18:35:17 tom Exp $ +.\" $Id: form_field_buffer.3x,v 1.17 2010/09/11 18:13:24 Jason.McIntyre 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 \fR .br @@ -49,10 +49,10 @@ The function \fBset_field_buffer\fR sets the numbered buffer of the given field 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. @@ -62,19 +62,19 @@ The function \fBfield_buffer\fR returns a pointer to 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. @@ -82,7 +82,7 @@ If you want the raw data, you must write your 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. @@ -122,7 +122,7 @@ descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header file .PP -When configured for wide-characters, \fBfield_buffer\fP returns a pointer +When configured for wide characters, \fBfield_buffer\fP returns a pointer to temporary storage (allocated and freed by the library). The application should not attempt to modify the data. It will be freed on the next call to \fBfield_buffer\fP to return the