2002-01-15 05:47:02 +03:00
|
|
|
.\" $NetBSD: form_new.3,v 1.2 2002/01/15 02:50:18 wiz Exp $
|
2001-07-08 16:10:28 +04:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2001
|
|
|
|
|
.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
|
|
|
|
|
.\"
|
|
|
|
|
.\" This code is donated to The NetBSD Foundation by the author.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. The name of the Author may not be used to endorse or promote
|
|
|
|
|
.\" products derived from this software without specific prior written
|
|
|
|
|
.\" permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.Dd January, 2001
|
|
|
|
|
.Dt FORMS 3
|
2002-01-15 05:47:02 +03:00
|
|
|
.Os
|
2001-07-08 16:10:28 +04:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm free_form ,
|
|
|
|
|
.Nm new_form
|
|
|
|
|
.Nd form library
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libform
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Fd #include <form.h>
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn free_form "FORM *form"
|
|
|
|
|
.Ft FORM *
|
|
|
|
|
.Fn new_form "FIELD **fields"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The function
|
|
|
|
|
.Fn free_form
|
|
|
|
|
frees all the resources associated with the form and destroys the
|
2002-01-15 05:47:02 +03:00
|
|
|
form. Calling
|
2001-07-08 16:10:28 +04:00
|
|
|
.Fn new_form
|
|
|
|
|
will create a new form, set the form parameters to the current
|
|
|
|
|
defaults and attach the passed fields to the form. The array of
|
|
|
|
|
fields passed to
|
|
|
|
|
.Fn new_form
|
|
|
|
|
must be terminated with a NULL pointer to indicate the end of the
|
|
|
|
|
fields.
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
Functions returning pointers will return NULL if an error is detected.
|
|
|
|
|
The functions that return an int will return one of the following error
|
|
|
|
|
values:
|
|
|
|
|
.Pp
|
|
|
|
|
.Bl -tag -width E_UNKNOWN_COMMAND -compact
|
|
|
|
|
.It Er E_OK
|
|
|
|
|
The function was successful.
|
|
|
|
|
.It Er E_BAD_ARGUMENT
|
|
|
|
|
The function was passed a bad argument.
|
|
|
|
|
.It Er E_POSTED
|
|
|
|
|
The form is posted to the screen.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr curses 3 ,
|
|
|
|
|
.Xr forms 3
|
|
|
|
|
.Sh NOTES
|
|
|
|
|
The header
|
|
|
|
|
.Pa <form.h>
|
|
|
|
|
automatically includes both
|
|
|
|
|
.Pa <curses.h>
|
|
|
|
|
and
|
|
|
|
|
.Pa <eti.h> .
|
