X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field.3x;h=b10e5af0b2dae6d2e977a7308f459f0bae2f63bf;hp=e916bf18255cb1092bc17b10fd234f83c38913dc;hb=f44733b760290aa8f51c6c9e1e463254833bffcd;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/man/form_field.3x b/man/form_field.3x index e916bf18..b10e5af0 100644 --- a/man/form_field.3x +++ b/man/form_field.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2003 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2012 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,10 +28,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field.3x,v 1.6 2003/05/10 20:33:49 jmc Exp $ +.\" $Id: form_field.3x,v 1.15 2020/03/28 19:06:28 tom Exp $ .TH form_field 3X "" .SH NAME -\fBform_field\fR - make and break connections between fields and forms +\fBform_field\fR \- make and break connections between fields and forms .SH SYNOPSIS \fB#include \fR .br @@ -45,53 +46,49 @@ int move_field(FIELD *field, int frow, int fcol); .SH DESCRIPTION The function \fBset_form_fields\fR changes the field pointer array of the given \fIform\fR. The array must be terminated by a \fBNULL\fR. - +.PP The function \fBform_fields\fR returns the field array of the given form. - +.PP The function \fBfield_count\fR returns the count of fields in \fIform\fR. - +.PP The function \fBmove_field\fR moves the given field (which must be disconnected) to a specified location on the screen. -.SH RETURN VALUES -The function \fBform_fields\fR returns \fBNULL\fR on error. - -The function \fBfield_count\fR returns \fBERR\fR (the general -\fBcurses\fR error return value) on error. - +.SH RETURN VALUE +The function \fBform_fields\fR returns a pointer (which may be \fBNULL\fR). +It does not set \fBerrno\fP. +.PP +The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter +is \fBNULL\fP. +.PP The functions \fBset_form_fields\fR and \fBmove_field\fR return one of the following codes on error: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_POSTED\fR +.B E_CONNECTED +The field is already connected to a form. +.TP 5 +.B E_POSTED The form is already posted. .TP 5 -\fBE_CONNECTED\fR -The field is already connected to a form. +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. - +.PP The SVr4 forms library documentation specifies the \fBfield_count\fR error value -as -1 (which is the value of \fBERR\fR). +as \-1 (which is the value of \fBERR\fR). .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.