1.\" $NetBSD: form_new.3,v 1.4 2002/02/20 11:30:59 wiz Exp $ 2.\" 3.\" Copyright (c) 2001 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd January 1, 2001 33.Dt FORMS 3 34.Os 35.Sh NAME 36.Nm free_form , 37.Nm new_form 38.Nd form library 39.Sh LIBRARY 40.Lb libform 41.Sh SYNOPSIS 42.Fd #include \*[Lt]form.h\*[Gt] 43.Ft int 44.Fn free_form "FORM *form" 45.Ft FORM * 46.Fn new_form "FIELD **fields" 47.Sh DESCRIPTION 48The function 49.Fn free_form 50frees all the resources associated with the form and destroys the 51form. Calling 52.Fn new_form 53will create a new form, set the form parameters to the current 54defaults and attach the passed fields to the form. The array of 55fields passed to 56.Fn new_form 57must be terminated with a NULL pointer to indicate the end of the 58fields. 59.Sh RETURN VALUES 60Functions returning pointers will return NULL if an error is detected. 61The functions that return an int will return one of the following error 62values: 63.Pp 64.Bl -tag -width E_UNKNOWN_COMMAND -compact 65.It Er E_OK 66The function was successful. 67.It Er E_BAD_ARGUMENT 68The function was passed a bad argument. 69.It Er E_POSTED 70The form is posted to the screen. 71.El 72.Sh SEE ALSO 73.Xr curses 3 , 74.Xr forms 3 75.Sh NOTES 76The header 77.Pa \*[Lt]form.h\*[Gt] 78automatically includes both 79.Pa \*[Lt]curses.h\*[Gt] 80and 81.Pa \*[Lt]eti.h\*[Gt] . 82