2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
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. *
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 *
29 .\"***************************************************************************
31 .\" $Id: menu_new.3x,v 1.15 2020/02/02 23:34:34 tom Exp $
35 \fBfree_menu\fR \- create and destroy menus
37 \fB#include <menu.h>\fR
39 MENU *new_menu(ITEM **items);
41 int free_menu(MENU *menu);
44 The function \fBnew_menu\fR creates a new menu connected to a specified item
45 pointer array (which must be \fBNULL\fR-terminated).
47 The function \fBfree_menu\fR disconnects \fImenu\fR from its item array
48 and frees the storage allocated for the menu.
50 The function \fBnew_menu\fR returns \fBNULL\fR on error.
51 It sets errno according to the function's failure:
54 No items are connected to the menu.
57 System error occurred, e.g., malloc failure.
59 The function \fBfree_menu\fR returns one of the following:
62 The routine succeeded.
65 System error occurred (see \fBerrno\fR(3)).
68 Routine detected an incorrect or out-of-range argument.
71 The menu has already been posted.
73 \fBcurses\fR(3X), \fBmenu\fR(3X).
75 The header file \fB<menu.h>\fR automatically includes the header file
78 These routines emulate the System V menu library.
79 They were not supported on
80 Version 7 or BSD versions.
83 Manual pages and adaptation for new curses by Eric S. Raymond.