form_field_buffer.3x man page

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:

The function field_buffer returns a pointer to the contents of the given numbered buffer:

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.

Return Value

The field_buffer function returns NULL on error. It sets errno according to their success:


The routine succeeded.


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:


The routine succeeded.


System error occurred (see errno(3)).


Routine detected an incorrect or out-of-range argument.

See Also

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 application 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 supported on Version 7 or BSD versions.

The set_max_field function checks for an ncurses extension O_INPUT_FIELD which allows a dynamic field to shrink if the new limit is smaller than the current field size.


Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.

Referenced By

The man pages field_buffer.3x(3), field_status.3x(3), set_field_buffer.3x(3), set_field_status.3x(3) and set_max_field.3x(3) are aliases of form_field_buffer.3x(3).