Debian Codegraph @

upstream/debian-trixie/man3/post.3form

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