Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

field_buffer(3CURSES)

Name

form_field_buffer, set_field_buffer, field_buffer, set_field_status, field_status, set_max_field - set and get forms field attributes

Synopsis

cc [ flag... ] file... –lform –lcurses [ library... ]
#include <form.h>



int set_field_buffer(FIELD *field, int buf, char *value);
char *field_buffer(FIELD *field, int buf);
int set_field_status(FIELD *field, int status);
int field_status(FIELD *field);
int set_max_field(FIELD *field, int max);

Description

set_field_buffer() sets buffer buf of field to value. Buffer 0 stores the displayed contents of the field. Buffers other than 0 are application specific and not used by the forms library routines. field_buffer() returns the value of field buffer buf.

Every field has an associated status flag that is set whenever the contents of field buffer 0 changes. set_field_status() sets the status flag of field to status. field_status() returns the status of field.

set_max_field() sets a maximum growth on a dynamic field, or if max=0 turns off any maximum growth.

Return Values

field_buffer() returns NULL on error.

field_status() returns TRUE or FALSE.

set_field_buffer(), set_field_status(), and set_max_field() return one of the following:

E_OK

The function returned successfully.

E_SYSTEM_ERROR

System error

E_BAD_ARGUMENT

An argument is incorrect.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
MT-Level
Unsafe

See Also

curses(3CURSES), forms(3CURSES), attributes(7)

Notes

The header <form.h> automatically includes the headers <eti.h> and <curses.h>.