'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH form_field 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
form_field, set_form_fields, form_fields, field_count, move_field \- connect fields to forms
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
#include <form.h>

\fBint\fR \fBset_form_fields\fR(\fBFORM *\fR\fIform\fR, \fBFIELD **\fR\fIfield\fR);
.fi

.LP
.nf
\fBFIELD **\fR\fBform_fields\fR(\fBFORM *\fR\fIform\fR);
.fi

.LP
.nf
\fBint\fR \fBfield_count\fR(\fBFORM *\fR\fIform\fR);
.fi

.LP
.nf
\fBint\fR \fBmove_field\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIfrow\fR, \fBint\fR \fIfcol\fR);
.fi

.SH DESCRIPTION
.sp
.LP
\fBset_form_fields()\fR changes the fields connected to \fIform\fR to \fIfields\fR. The original fields are disconnected.
.sp
.LP
\fBform_fields()\fR returns a pointer to the field pointer array connected to \fIform\fR.
.sp
.LP
\fBfield_count()\fR returns the number of fields connected to \fIform\fR.
.sp
.LP
\fBmove_field()\fR moves the disconnected \fIfield\fR to the location \fIfrow, fcol\fR in the \fBforms\fR subwindow.
.SH RETURN VALUES
.sp
.LP
\fBform_fields()\fR returns \fINULL\fR on error.
.sp
.LP
\fBfield_count()\fR returns \fB-1\fR on error.
.sp
.LP
\fBset_form_fields()\fR and \fBmove_field()\fR return one of the following: 
.sp
.ne 2
.mk
.na
\fBE_OK \fR
.ad
.RS 18n
.rt  
The function returned successfully.
.RE

.sp
.ne 2
.mk
.na
\fBE_CONNECTED\fR
.ad
.RS 18n
.rt  
The field is already connected to a form.
.RE

.sp
.ne 2
.mk
.na
\fBE_SYSTEM_ERROR\fR
.ad
.RS 18n
.rt  
System error.
.RE

.sp
.ne 2
.mk
.na
\fBE_BAD_ARGUMENT\fR
.ad
.RS 18n
.rt  
An argument is incorrect
.RE

.sp
.ne 2
.mk
.na
\fBE_POSTED\fR
.ad
.RS 18n
.rt  
The form is posted.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and \fB<curses.h>\fR\&.