form_post.3 revision 1.9
$NetBSD: form_post.3,v 1.9 2004/11/24 12:47:20 wiz Exp $
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 1, 2001 .Dt FORMS 3 .Os .Sh NAME .Nm post_form , .Nm unpost_form .Nd form library .Sh LIBRARY .Lb libform .Sh SYNOPSIS n form.h .Ft int .Fn post_form "FORM *form" .Ft int .Fn unpost_form "FORM *form" .Sh DESCRIPTION The .Fn post_form function performs the actions necessary to present the form on the curses screen. If there are any init functions that need to be called then they will be called prior to the form being posted and the cursor will be positioned on the first active field that can be visited. Conversely, the function .Fn unpost_form removes the form from the screen and calls any termination functions that were specified. .Sh RETURN VALUES The functions will return one of the following error values:
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 1, 2001 .Dt FORMS 3 .Os .Sh NAME .Nm post_form , .Nm unpost_form .Nd form library .Sh LIBRARY .Lb libform .Sh SYNOPSIS n form.h .Ft int .Fn post_form "FORM *form" .Ft int .Fn unpost_form "FORM *form" .Sh DESCRIPTION The .Fn post_form function performs the actions necessary to present the form on the curses screen. If there are any init functions that need to be called then they will be called prior to the form being posted and the cursor will be positioned on the first active field that can be visited. Conversely, the function .Fn unpost_form removes the form from the screen and calls any termination functions that were specified. .Sh RETURN VALUES The functions will return one of the following error values:
p l -tag -width E_UNKNOWN_COMMAND -compact t Er E_OK The function was successful. t Er E_BAD_ARGUMENT A bad argument was passed to the function. t Er E_POSTED The form is already posted to the screen. t Er E_NOT_POSTED The form was not posted to the screen. t Er E_NOT_CONNECTED There are no fields associated with the form. t Er E_BAD_STATE The function was called from within a init or term function. .El .Sh SEE ALSO .Xr curses 3 , .Xr forms 3 .Sh NOTES The header .Aq Pa form.h automatically includes both .Aq Pa curses.h and .Aq Pa eti.h .