form_field_buffer(3)
- NetBSD Manual Pages
FORMS(3) NetBSD Programmer's Manual FORMS(3)
NAME
field_buffer, field_status, set_field_buffer, set_field_status,
set_max_field - form library
LIBRARY
Curses Form Library (libform, -lform)
SYNOPSIS
#include <form.h>
char *
field_buffer(FIELD *field, int buffer);
int
field_status(FIELD *field);
int
set_field_buffer(FIELD *field, int buffer, char *value);
int
set_field_status(FIELD *field, int status);
DESCRIPTION
The field_buffer() function returns the contents of the buffer number
specified by buffer for the given field. If the requested buffer number
exceeds the number of buffers attached to the field then NULL will be re-
turned. The field buffer may be set by calling set_field_buffer() which
will set the given buffer number to the contents of the string passed.
Calling field_status() will return the status of the first buffer at-
tached to the field. If the field has been modified then the function
will return TRUE otherwise FALSE is returned, the status of the first
buffer may be programmatically set by calling set_field_status(). The
maximum growth of a dynamic field can be set by calling set_max_field()
which limits the fields rows if the field is a multiline field or the
fields columns if the field only has a single row.
RETURN VALUES
Functions returning pointers will return NULL if an error is detected.
The functions that return an int will return one of the following error
values:
E_OK The function was successful.
E_BAD_ARGUMENT A bad parameter was passed to the function.
E_SYSTEM_ERROR A system error occurred performing the function.
SEE ALSO
curses(3), forms(3)
NOTES
The header <form.h> automatically includes both <curses.h> and <eti.h>.
NetBSD 1.6.2 January 1, 2001 1
Powered by man-cgi (2024-03-20).
Maintained for NetBSD
by Kimmo Suominen.
Based on man-cgi by Panagiotis Christias.