X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_buffer.3x.html;h=55eb6998cca1a5256835d7986740fea4e3e4b301;hp=a4f3dcda1516fbe7f7dcad545aa4a96861dfb7e8;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html index a4f3dcda..55eb6998 100644 --- a/doc/html/man/form_field_buffer.3x.html +++ b/doc/html/man/form_field_buffer.3x.html @@ -1,137 +1,166 @@ + + +
+ + +- +form_field_buffer(3x) form_field_buffer(3x) --
- form_field_buffer - field buffer control - - --
- #include <form.h> - 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); - - --
- The function set_field_buffer 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 nbuf argument - of (see form_field_new(3x)) but are not manipulated by the - forms library. The function field_buffer 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 set_field_status sets the associated status - flag of field; field_status gets the current value. The - status flag is set to a nonzero value whenever the field - changes. - - The function set_max_field sets the maximum size for a - dynamic field. An argument of 0 turns off any maximum - size threshold for that field. - - --
- The field_buffer function returns NULL on error. - - The field_status function returns TRUE or FALSE. - - The remaining routines return one of the following: - - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. - - --
- curses(3x) and 3x pages whose names begin "form_" for - detailed descriptions of the entry points. - - --
- The header file <form.h> automatically includes the header - file <curses.h>. - - --
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. - - --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +
+ form_field_buffer - field buffer control +
+ #include <form.h> + 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); +
+ The function set_field_buffer sets the numbered buffer of the given + field to contain a given string: + o Buffer 0 is the displayed value of the field. + o Other numbered buffers may be allocated by applications through + the nbuf argument of (see form_field_new(3x)) but are not manip- + ulated by the forms library. + The function field_buffer returns a pointer to the contents of the + given numbered buffer: + o The buffer contents always have the same length, and are padded + with trailing spaces as needed to ensure this length is the + same. + o The buffer may contain leading spaces, depending on how it was + set. + o The buffer contents are set with set_field_buffer, or as a side + effect of any editing operations on the corresponding field. + o Editing operations are based on the window which displays the + field, rather than a string. The window contains only printable + characters, and is filled with blanks. 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. + o 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. + The function set_field_status sets the associated status flag of field; + field_status gets the current value. The status flag is set to a + nonzero value whenever the field changes. + The function set_max_field sets the maximum size for a dynamic field. + An argument of 0 turns off any maximum size threshold for that field. +
+ The field_buffer function returns NULL on error. It sets errno accord- + ing to their success: + E_OK The routine succeeded. + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. + The field_status function returns TRUE or FALSE. + The remaining routines return one of the following: + E_OK The routine succeeded. + E_SYSTEM_ERROR + System error occurred (see errno). + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. +
+ curses(3x) and related pages whose names begin "form_" for detailed + descriptions of the entry points. +
+ The header file <form.h> automatically includes the header file + When configured for wide characters, field_buffer returns a pointer to + temporary storage (allocated and freed by the library). The applica- + tion should not attempt to modify the data. It will be freed on the + next call to field_buffer to return the same buffer. <curses.h>. +
+ These routines emulate the System V forms library. They were not sup- + ported on Version 7 or BSD versions. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. + form_field_buffer(3x)-