1.\" $NetBSD: form_post.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 post_form , 37.Nm unpost_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 post_form "FORM *form" 45.Ft int 46.Fn unpost_form "FORM *form" 47.Sh DESCRIPTION 48The 49.Fn post_form 50function performs the actions necessary to present the form on the 51curses screen. If there are any init functions that need to be called 52then they will be called prior to the form being posted and the cursor 53will be positioned on the first active field that can be visited. 54Conversely, the function 55.Fn unpost_form 56removes the form from the screen and calls any termination functions 57that were specified. 58.Sh RETURN VALUES 59Functions returning pointers will return NULL if an error is detected. 60The functions that return an int will return one of the following error 61values: 62.Pp 63.Bl -tag -width E_UNKNOWN_COMMAND -compact 64.It Er E_OK 65The function was successful. 66.It Er E_BAD_ARGUMENT 67A bad argument was passed to the function. 68.It Er E_POSTED 69The form is already posted to the screen. 70.It Er E_NOT_POSTED 71The form was not posted to the screen. 72.It Er E_NOT_CONNECTED 73There are no fields associated with the form. 74.It Er E_BAD_STATE 75The function was called from within a init or term function. 76.El 77.Sh SEE ALSO 78.Xr curses 3 , 79.Xr forms 3 80.Sh NOTES 81The header 82.Pa \*[Lt]form.h\*[Gt] 83automatically includes both 84.Pa \*[Lt]curses.h\*[Gt] 85and 86.Pa \*[Lt]eti.h\*[Gt] . 87