ncurses 6.0 - patch 20180106
[ncurses.git] / doc / html / man / menu_post.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_post.3x,v 1.14 2017/01/07 19:25:15 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_post 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_post 3x</H1>
43 <PRE>
44 <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>                                                    <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>post_menu</STRONG>,  <STRONG>unpost_menu</STRONG>  - write or erase menus from associated subwin-
51        dows
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int post_menu(MENU *menu);
57        int unpost_menu(MENU *menu);
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        The function <STRONG>post_menu</STRONG> displays a menu to its associated subwindow.  To
62        trigger  physical  display  of  the  subwindow, use <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> or some
63        equivalent <STRONG>curses</STRONG> routine (the implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG>
64        input  request  will  do). <STRONG>post_menu</STRONG> resets the selection status of all
65        items.
66
67        The function <STRONG>unpost_menu</STRONG> erases menu from its associated subwindow.
68
69
70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
71        These routines return one of the following:
72
73        <STRONG>E_OK</STRONG> The routine succeeded.
74
75        <STRONG>E_SYSTEM_ERROR</STRONG>
76             System error occurred (see <STRONG>errno</STRONG>).
77
78        <STRONG>E_BAD_ARGUMENT</STRONG>
79             Routine detected an incorrect or out-of-range argument.
80
81        <STRONG>E_POSTED</STRONG>
82             The menu has already been posted.
83
84        <STRONG>E_BAD_STATE</STRONG>
85             Routine was called from an initialization or termination function.
86
87        <STRONG>E_NO_ROOM</STRONG>
88             Menu is too large for  its  window.   You  should  consider  using
89             <STRONG>set_menu_format</STRONG> to solve the problem.
90
91        <STRONG>E_NOT_POSTED</STRONG>
92             The menu has not been posted.
93
94        <STRONG>E_NOT_CONNECTED</STRONG>
95             No items are connected to the menu.
96
97
98 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
99        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
100
101
102 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
103        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
104        <STRONG>&lt;curses.h&gt;</STRONG>.
105
106
107 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
108        These routines emulate the System V menu library.  They were  not  sup-
109        ported on Version 7 or BSD versions.
110
111
112 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
113        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
114        Raymond.
115
116
117
118                                                                  <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
119 </PRE>
120 <div class="nav">
121 <ul>
122 <li><a href="#h2-NAME">NAME</a></li>
123 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
124 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
125 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
126 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
127 <li><a href="#h2-NOTES">NOTES</a></li>
128 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
129 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
130 </ul>
131 </div>
132 </BODY>
133 </HTML>