diff options
Diffstat (limited to 'lib/libform/form_field_new.3')
| -rw-r--r-- | lib/libform/form_field_new.3 | 40 |
1 files changed, 25 insertions, 15 deletions
diff --git a/lib/libform/form_field_new.3 b/lib/libform/form_field_new.3 index 232803a9dd4..3528bb91907 100644 --- a/lib/libform/form_field_new.3 +++ b/lib/libform/form_field_new.3 @@ -1,8 +1,8 @@ '\" t -.\" $OpenBSD: form_field_new.3,v 1.9 2003/05/16 08:48:27 jmc Exp $ +.\" $OpenBSD: form_field_new.3,v 1.10 2010/01/12 23:22:07 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -29,7 +29,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.'" $From: form_field_new.3x,v 1.9 1998/11/29 01:06:44 Rick.Ohnemus Exp $ +.\" $Id: form_field_new.3,v 1.10 2010/01/12 23:22:07 nicm Exp $ .TH form_field_new 3 "" .SH NAME \fBform_field_new\fR - create and destroy form fields @@ -50,31 +50,41 @@ 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. - +.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 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. - +.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(3), \fBform\fR(3). .SH NOTES @@ -83,10 +93,10 @@ The header file \fB<form.h>\fR automatically includes the header file .SH PORTABILITY 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(3) being portable; the System V forms library documents are -not very explicit about what gets copied and what doesn't. +\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. |