ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / menu_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 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_new.3x,v 1.12 2015/12/05 23:42:45 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 http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_new 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_new 3x</H1>
43 <PRE>
44 <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>                                               <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>new_menu</STRONG>, <STRONG>free_menu</STRONG> - create and destroy menus
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        MENU *new_menu(ITEM **items);
58        int free_menu(MENU *menu);
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The  function  <STRONG>new_menu</STRONG>  creates a new menu connected to a
64        specified item pointer array (which  must  be  <STRONG>NULL</STRONG>-termi-
65        nated).
66
67        The  function  <STRONG>free_menu</STRONG>  disconnects  <EM>menu</EM>  from its item
68        array and frees the storage allocated for the menu.
69
70
71 </PRE>
72 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The function <STRONG>new_menu</STRONG> returns  <STRONG>NULL</STRONG>  on  error.   It  sets
74        errno according to the function's failure:
75
76        <STRONG>E_NOT_CONNECTED</STRONG>
77             No items are connected to the menu.
78
79        <STRONG>E_SYSTEM_ERROR</STRONG>
80             System error occurred, e.g., malloc failure.
81
82        The function <STRONG>free_menu</STRONG> returns one of the following:
83
84        <STRONG>E_OK</STRONG> The routine succeeded.
85
86        <STRONG>E_SYSTEM_ERROR</STRONG>
87             System error occurred (see <STRONG>errno</STRONG>).
88
89        <STRONG>E_BAD_ARGUMENT</STRONG>
90             Routine  detected  an incorrect or out-of-range argu-
91             ment.
92
93        <STRONG>E_POSTED</STRONG>
94             The menu has already been posted.
95
96
97 </PRE>
98 <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>
103 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
104        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
105        file <STRONG>&lt;curses.h&gt;</STRONG>.
106
107
108 </PRE>
109 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
110        These  routines  emulate  the System V menu library.  They
111        were not supported on Version 7 or BSD versions.
112
113
114 </PRE>
115 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
116        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
117        curses by Eric S. Raymond.
118
119
120
121                                                            <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
122 </PRE>
123 <div class="nav">
124 <ul>
125 <li><a href="#h2-NAME">NAME</a></li>
126 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
127 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
128 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
129 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
130 <li><a href="#h2-NOTES">NOTES</a></li>
131 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
132 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
133 </ul>
134 </div>
135 </BODY>
136 </HTML>