X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_buffer.3x.html;h=fe6b531f44d8bb16c863e0521c60f8976ad73e28;hb=f367fa254ce3fe29710c86971f04e03111c2bd2c;hp=1de81f1b5d0829b8f9ab172b6d90934eb6422950;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html index 1de81f1b..fe6b531f 100644 --- a/doc/html/man/form_field_buffer.3x.html +++ b/doc/html/man/form_field_buffer.3x.html @@ -2,7 +2,7 @@
@@ -54,6 +54,7 @@#include <form.h> + int set_field_buffer(FIELD *field, int buf, const char *value); char *field_buffer(const FIELD *field, int buffer); @@ -65,21 +66,41 @@
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 do not use it for long term storage of the - entered form data. + 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 applica- + tions through the nbuf argument of (see + form_field_new(3x)) but are not manipulated by the + forms library. + + The function field_buffer returns a pointer to the con- + tents 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 win- + dow 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 @@ -93,7 +114,14 @@
- The field_buffer function returns NULL on error. + The field_buffer function returns NULL on error. It sets + errno according to their success: + + E_OK The routine succeeded. + + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argu- + ment. The field_status function returns TRUE or FALSE. @@ -120,7 +148,7 @@ The header file <form.h> automatically includes the header file - When configured for wide-characters, field_buffer returns + When configured for wide characters, field_buffer 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