form_field_buffer.3curses revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
form_field_buffer 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
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

Thefunction returned successfully.

E_SYSTEM_ERROR

System error

E_BAD_ARGUMENT

An argument is incorrect.

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe
SEE ALSO

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

NOTES

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