ncurses 4.2
[ncurses.git] / man / menu_post.3x
1 '\" t
2 .TH menu_post 3X ""
3 .SH NAME
4 \fBmenu_post\fR - write or erase menus from associated subwindows
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 int post_menu(MENU *menu);
9 .br
10 int unpost_menu(MENU *menu);
11 .br
12 .SH DESCRIPTION
13 The function \fBpost_menu\fR displays a menu to its associated subwindow.  To
14 trigger physical display of the subwindow, use \fBrefresh\fR or some equivalent
15 \fBcurses\fR routine (the implicit \fBdoupdate\fR triggered by an \fBcurses\fR
16 input request will do). \fBpost_menu\fR resets the selection status of all items.
17
18 The function \fBunpost_menu\fR erases menu from its associated subwindow.
19 .SH RETURN VALUE
20 These routines return one of the following:
21 .TP 5
22 \fBE_OK\fR
23 The routine succeeded.
24 .TP 5
25 \fBE_SYSTEM_ERROR\fR
26 System error occurred (see \fBerrno\fR).
27 .TP 5
28 \fBE_BAD_ARGUMENT\fR
29 Routine detected an incorrect or out-of-range argument.
30 .TP 5
31 \fBE_POSTED\fR
32 The menu has already been posted.
33 .TP 5
34 \fBE_BAD_STATE\fR
35 Routine was called from an initialization or termination function.
36 .TP 5
37 \fBE_NO_ROOM\fR
38 Menu is too large for its window. You should consider to use
39 \fBset_menu_format()\fR to solve the problem.
40 .TP 5
41 \fBE_NOT_POSTED\fR
42 The menu has not been posted.
43 .TP 5
44 \fBE_NOT_CONNECTED\fR
45 No items are connected to the menu.
46 .SH SEE ALSO
47 \fBcurses\fR(3X), \fBmenu\fR(3X).
48 .SH NOTES
49 The header file \fB<menu.h>\fR automatically includes the header file
50 \fB<curses.h>\fR.
51 .SH PORTABILITY
52 These routines emulate the System V menu library.  They were not supported on
53 Version 7 or BSD versions.
54 .SH AUTHORS
55 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
56 S. Raymond.
57 .\"#
58 .\"# The following sets edit modes for GNU EMACS
59 .\"# Local Variables:
60 .\"# mode:nroff
61 .\"# fill-column:79
62 .\"# End: