xref: /freebsd/contrib/ncurses/man/form_post.3x (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
t
***************************************************************************
Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
*
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_post.3x,v 1.9 2010/12/04 18:40:45 tom Exp $
form_post 3X ""
NAME
form_post - write or erase forms from associated subwindows
SYNOPSIS
#include <form.h>

int post_form(FORM *form);

int unpost_form(FORM *form);

DESCRIPTION
The function post_form displays a form to its associated subwindow. To trigger physical display of the subwindow, use refresh or some equivalent curses routine (the implicit doupdate triggered by an curses input request will do).

The function unpost_form erases form from its associated subwindow.

RETURN VALUE
These routines return one of the following:

5 E_OK The routine succeeded.

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_BAD_STATE Routine was called from an initialization or termination function.

5 E_NOT_POSTED The form has not been posted.

5 E_NOT_CONNECTED No items are connected to the form.

5 E_NO_ROOM Form is too large for its window.

5 E_POSTED The form has already been posted.

5 E_SYSTEM_ERROR System error occurred (see errno). .

SEE ALSO
curses(3X), form(3X).
NOTES
The header file <form.h> automatically includes the header file <curses.h>.
PORTABILITY
These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.