jcs.org
jcs's openbsd hax
openbsd
1'\" t
2.\" $OpenBSD: form_post.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
3.\"
4.\"***************************************************************************
5.\" Copyright 2018-2022,2023 Thomas E. Dickey *
6.\" Copyright 1998-2015,2017 Free Software Foundation, Inc. *
7.\" *
8.\" Permission is hereby granted, free of charge, to any person obtaining a *
9.\" copy of this software and associated documentation files (the *
10.\" "Software"), to deal in the Software without restriction, including *
11.\" without limitation the rights to use, copy, modify, merge, publish, *
12.\" distribute, distribute with modifications, sublicense, and/or sell *
13.\" copies of the Software, and to permit persons to whom the Software is *
14.\" furnished to do so, subject to the following conditions: *
15.\" *
16.\" The above copyright notice and this permission notice shall be included *
17.\" in all copies or substantial portions of the Software. *
18.\" *
19.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
20.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
21.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
22.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
23.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
24.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
25.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26.\" *
27.\" Except as contained in this notice, the name(s) of the above copyright *
28.\" holders shall not be used in advertising or otherwise to promote the *
29.\" sale, use or other dealings in this Software without prior written *
30.\" authorization. *
31.\"***************************************************************************
32.\"
33.\" $Id: form_post.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
34.TH form_post 3 2023-07-01 "ncurses 6.4" "Library calls"
35.SH NAME
36\fBpost_form\fP,
37\fBunpost_form\fP \- write or erase forms from associated subwindows
38.SH SYNOPSIS
39\fB#include <form.h>\fP
40.sp
41\fBint post_form(FORM *\fIform\fB);\fR
42.br
43\fBint unpost_form(FORM *\fIform\fB);\fR
44.SH DESCRIPTION
45The function \fBpost_form\fP displays a form to its associated subwindow.
46To trigger physical display of the subwindow,
47use \fBrefresh\fP(3) or some equivalent
48\fBcurses\fP routine (the implicit \fBdoupdate\fP triggered by an \fBcurses\fP
49input request will do).
50.PP
51The function \fBunpost_form\fP erases form from its associated subwindow.
52.SH RETURN VALUE
53These routines return one of the following:
54.TP 5
55.B E_OK
56The routine succeeded.
57.TP 5
58.B E_BAD_ARGUMENT
59Routine detected an incorrect or out-of-range argument.
60.TP 5
61.B E_BAD_STATE
62Routine was called from an initialization or termination function.
63.TP 5
64.B E_NOT_POSTED
65The form has not been posted.
66.TP 5
67.B E_NOT_CONNECTED
68No items are connected to the form.
69.TP 5
70.B E_NO_ROOM
71Form is too large for its window.
72.TP 5
73.B E_POSTED
74The form has already been posted.
75.TP 5
76.B E_SYSTEM_ERROR
77System error occurred (see \fBerrno\fP(3)).
78.
79.SH SEE ALSO
80\fBcurses\fP(3), \fBform\fP(3).
81.SH NOTES
82The header file \fB<form.h>\fP automatically includes the header file
83\fB<curses.h>\fP.
84.SH PORTABILITY
85These routines emulate the System V forms library.
86They were not supported on
87Version 7 or BSD versions.
88.SH AUTHORS
89Juergen Pfeifer.
90Manual pages and adaptation for new curses by Eric S. Raymond.