X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_new.3x;h=47398174fad8674e3334154100dcb8fa050d537d;hp=0f4c5015d11b5640518924725479f3e734ca014c;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_new.3x b/man/form_new.3x index 0f4c5015..47398174 100644 --- a/man/form_new.3x +++ b/man/form_new.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 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,38 +28,49 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_new.3x,v 1.5 1998/11/29 01:07:37 Rick.Ohnemus Exp $ +.\" $Id: form_new.3x,v 1.15 2020/10/24 09:02:26 tom Exp $ .TH form_new 3X "" .SH NAME -\fBform_new\fR - create and destroy forms +\fBnew_form\fR, +\fBfree_form\fP \- create and destroy forms .SH SYNOPSIS \fB#include \fR +.sp +\fBFORM *new_form(FIELD **\fP\fIfields\fP\fB);\fP .br -FORM *new_form(FIELD **fields); -.br -int free_form(FORM *form); +\fBint free_form(FORM *\fP\fIform\fP\fB);\fP .br .SH DESCRIPTION The function \fBnew_form\fR creates a new form connected to a specified field pointer array (which must be \fBNULL\fR-terminated). - +.PP The function \fBfree_form\fR disconnects \fIform\fR from its field array and frees the storage allocated for the form. .SH RETURN VALUE The function \fBnew_form\fR returns \fBNULL\fR on error. - -The function \fBfree_form\fR returns one of the following: +It sets \fBerrno\fP according to the function's 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_CONNECTED +The field is already connected to a form. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred, e.g., malloc failure. +.PP +The function \fBfree_form\fR returns one of the following: +.TP 5 +.B E_OK +The routine succeeded. .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_POSTED The form has already been posted. .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). @@ -66,14 +78,9 @@ The form has already been posted. 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. .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.