diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/form_field_buffer.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/form_field_buffer.3x.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/form_field_buffer.3x.html b/ncurses-5.2/doc/html/man/form_field_buffer.3x.html new file mode 100644 index 0000000..a4f3dcd --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_buffer.3x.html @@ -0,0 +1,137 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_buffer</B> - field buffer control + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_buffer(FIELD *field, int buf, const char + *value); + char *field_buffer(const FIELD *field, int buffer); + int set_field_status(FIELD *field, bool status); + bool field_status(const FIELD *field); + int set_max_field(FIELD *field, int max); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_buffer</B> sets the numbered buffer of + the given field to contain a given string. Buffer 0 is + the displayed value of the field; other numbered buffers + may be allocated by applications through the <B>nbuf</B> argument + of (see <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B>) but are not manipulated by the + forms library. The function <B>field_buffer</B> returns the + address of the buffer. Please note that this buffer has + always the length of the buffer, that means that it may + typically contain trailing spaces. If you entered leading + spaces the buffer may also contain them. 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 trail- + ing spaces. Please note also, that subsequent operations + on the form will probably change the content of the + buffer. So don't use it for long term storage of the + entered form data. + + The function <B>set_field_status</B> sets the associated status + flag of <I>field</I>; <B>field_status</B> gets the current value. The + status flag is set to a nonzero value whenever the field + changes. + + The function <B>set_max_field</B> sets the maximum size for a + dynamic field. An argument of 0 turns off any maximum + size threshold for that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <B>field_buffer</B> function returns NULL on error. + + The <B>field_status</B> function returns <B>TRUE</B> or <B>FALSE</B>. + + The remaining routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |