Debian Codegraph @

upstream/debian-unstable/man3/new.3menu

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 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: menu_new.3x,v 1.37 2024/12/28 21:26:21 tom Exp $
31 .TH new 3MENU 2024-12-28 "ncurses 6.6" "Library calls"
32 .SH NAME
33 \fBnew_menu\fP,
34 \fBfree_menu\fP \-
35 create and destroy menus
36 .SH SYNOPSIS
37 .nf
38 \fB#include <menu.h>
39 .PP
40 \fBMENU *new_menu(ITEM **\fIitems\fP);
41 \fBint free_menu(MENU *\fImenu\fP);
42 .fi
43 .SH DESCRIPTION
44 The function \fBnew_menu\fP creates a new menu connected to a specified item
45 pointer array (which must be
46 .IR NULL -terminated).
47 .PP
48 The function \fBfree_menu\fP disconnects \fImenu\fP from its item array
49 and frees the storage allocated for the menu.
50 .SH RETURN VALUE
51 The function \fBnew_menu\fP returns
52 .I NULL
53 on error.
54 It sets \fBerrno\fP according to the function's failure:
55 .TP 5
56 .B E_NOT_CONNECTED
57 No items are connected to the menu.
58 .TP 5
59 .B E_SYSTEM_ERROR
60 System error occurred, e.g., malloc failure.
61 .PP
62 The function \fBfree_menu\fP returns one of the following:
63 .TP 5
64 .B E_OK
65 The routine succeeded.
66 .TP 5
67 .B E_SYSTEM_ERROR
68 System error occurred (see \fBerrno\fP(3)).
69 .TP 5
70 .B E_BAD_ARGUMENT
71 Routine detected an incorrect or out-of-range argument.
72 .TP 5
73 .B E_POSTED
74 The menu has already been posted.
75 .SH PORTABILITY
76 These routines emulate the System V menu library.
77 They were not supported on
78 Version 7 or BSD versions.
79 .SH AUTHORS
80 Juergen Pfeifer.
81 Manual pages and adaptation for new curses by Eric S. Raymond.
82 .SH SEE ALSO
83 \fB\%ncurses\fP(3NCURSES),
84 \fB\%menu\fP(3MENU)