X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_buffer.3x.html;h=4e0bba1149222c98e8a62049ebef53160d54a9c2;hp=a4f3dcda1516fbe7f7dcad545aa4a96861dfb7e8;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html index a4f3dcda..4e0bba11 100644 --- a/doc/html/man/form_field_buffer.3x.html +++ b/doc/html/man/form_field_buffer.3x.html @@ -1,16 +1,59 @@ + + +
++form_field_buffer(3x) form_field_buffer(3x) + + +
- form_field_buffer - field buffer control + form_field_buffer - field buffer control
- #include <form.h> + #include <form.h> int set_field_buffer(FIELD *field, int buf, const char *value); char *field_buffer(const FIELD *field, int buffer); @@ -21,61 +64,94 @@
- 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 + 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 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: + + - The buffer contents always have the same length, and + are padded with trailing spaces as needed to ensure + this length is the same. + + - The buffer may contain leading spaces, depending on + how it was set. + + - The buffer contents are set with set_field_buffer, + or as a side effect of any editing operations on the + corresponding field. + + - 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 trail- + ing spaces. + + - 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 + 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_buffer function returns NULL on error. It sets + errno according to their success: - The field_status function returns TRUE or FALSE. + 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. The remaining routines return one of the following: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno). + E_SYSTEM_ERROR + System error occurred (see errno). - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argu- ment.
- curses(3x) and 3x pages whose names begin "form_" for + 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 <curses.h>. + 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 application should not attempt to modify + the data. It will be freed on the next call to field_buf- + fer to return the same buffer. <curses.h>.@@ -91,42 +167,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + form_field_buffer(3x)