X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_new.3x;h=38f34bbe6e394737758dd7a1e9bd063b74640252;hp=b798b5bb3e95bc8d83548bb46d616c9cdde07ee1;hb=b60a2772d9f149d8e900c1d5a09a53a56a0837a8;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_field_new.3x b/man/form_field_new.3x index b798b5bb..38f34bbe 100644 --- a/man/form_field_new.3x +++ b/man/form_field_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2015,2018 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 +27,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.'" $Id: form_field_new.3x,v 1.9 1998/11/29 01:06:44 Rick.Ohnemus Exp $ +.\" $Id: form_field_new.3x,v 1.20 2018/07/28 21:34:06 tom Exp $ .TH form_field_new 3X "" .SH NAME -\fBform_field_new\fR - create and destroy form fields +\fBnew_field\fR, +\fBdup_field\fR, +\fBlink_field\fR, +\fBfree_field\fR \- create and destroy form fields .SH SYNOPSIS \fB#include \fR .br @@ -48,49 +51,57 @@ int free_field(FIELD *field); The function \fBnew_field\fR allocates a new field and initializes it from the parameters given: height, width, row of upper-left corner, column of upper-left corner, number off-screen rows, and number of additional working buffers. - -The function \fBdup_field\fR duplicates a field at a new location. Most +.PP +The function \fBdup_field\fR duplicates a field at a new location. +Most attributes (including current contents, size, validation type, buffer count, growth threshold, justification, foreground, background, pad character, -options, and user pointer) are copied. Field status and the field page bit are +options, and user pointer) are copied. +Field status and the field page bit are not copied. - +.PP The function \fBlink_field\fR acts like \fBdup_field\fR, but the new field -shares buffers with its parent. Attribute data is separate. - +shares buffers with its parent. +Attribute data is separate. +.PP The function \fBfree_field\fR de-allocates storage associated with a field. .SH RETURN VALUE The function, \fBnew_field\fR, \fBdup_field\fR, \fBlink_field\fR return \fBNULL\fR on error. - -The function \fBfree_field\fR returns one of the following: +They set errno according to their success: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_BAD_ARGUMENT +Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred, e.g., malloc failure. +.PP +The function \fBfree_field\fR returns one of the following: .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_OK +The routine succeeded. +.TP 5 +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_CONNECTED +field is connected. .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 It may be unwise to count on the set of attributes copied by -\fBdup_field\fR(3X) being portable; the System V forms library documents are -not very explicit on what gets copied and was not. +\fBdup_field\fR being portable; the System V forms library documents are +not very explicit about what gets copied and what does not. .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.