ncursesw-morphos/man/form_new.3x

87 lines
3.7 KiB
Plaintext
Raw Normal View History

1997-05-15 12:00:00 +08:00
'\" t
1999-10-24 12:32:42 +08:00
.\"***************************************************************************
.\" Copyright 2018,2020 Thomas E. Dickey *
.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
1999-10-24 12:32:42 +08:00
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" "Software"), to deal in the Software without restriction, including *
.\" without limitation the rights to use, copy, modify, merge, publish, *
.\" distribute, distribute with modifications, sublicense, and/or sell *
.\" copies of the Software, and to permit persons to whom the Software is *
.\" furnished to do so, subject to the following conditions: *
.\" *
.\" The above copyright notice and this permission notice shall be included *
.\" in all copies or substantial portions of the Software. *
.\" *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
.\" *
.\" Except as contained in this notice, the name(s) of the above copyright *
.\" holders shall not be used in advertising or otherwise to promote the *
.\" sale, use or other dealings in this Software without prior written *
.\" authorization. *
.\"***************************************************************************
.\"
.\" $Id: form_new.3x,v 1.15 2020/10/24 09:02:26 tom Exp $
1997-05-15 12:00:00 +08:00
.TH form_new 3X ""
.SH NAME
\fBnew_form\fR,
\fBfree_form\fP \- create and destroy forms
1997-05-15 12:00:00 +08:00
.SH SYNOPSIS
\fB#include <form.h>\fR
.sp
\fBFORM *new_form(FIELD **\fP\fIfields\fP\fB);\fP
1997-05-15 12:00:00 +08:00
.br
\fBint free_form(FORM *\fP\fIform\fP\fB);\fP
1997-05-15 12:00:00 +08:00
.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).
2006-12-18 12:32:42 +08:00
.PP
1997-05-15 12:00:00 +08:00
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.
It sets \fBerrno\fP according to the function's success:
1997-05-15 12:00:00 +08:00
.TP 5
2006-12-18 12:32:42 +08:00
.B E_OK
1997-05-15 12:00:00 +08:00
The routine succeeded.
.TP 5
2006-12-18 12:32:42 +08:00
.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.
1997-05-15 12:00:00 +08:00
.TP 5
2006-12-18 12:32:42 +08:00
.B E_BAD_ARGUMENT
1997-05-15 12:00:00 +08:00
Routine detected an incorrect or out-of-range argument.
.TP 5
2006-12-18 12:32:42 +08:00
.B E_POSTED
1997-05-15 12:00:00 +08:00
The form has already been posted.
.SH SEE ALSO
\fBcurses\fR(3X), \fBform\fR(3X).
.SH NOTES
The header file \fB<form.h>\fR automatically includes the header file
\fB<curses.h>\fR.
.SH PORTABILITY
These routines emulate the System V forms library.
They were not supported on
1997-05-15 12:00:00 +08:00
Version 7 or BSD versions.
.SH AUTHORS
Juergen Pfeifer.
Manual pages and adaptation for new curses by Eric S. Raymond.