2 .\"***************************************************************************
3 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
4 .\" Copyright 1998-2012,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_items.3x,v 1.24 2023/07/01 15:46:10 tom Exp $
32 .TH menu_items 3X 2023-07-01 "ncurses 6.4" "Library calls"
36 \fBitem_count\fP \- make and break connections between items and menus
38 \fB#include <menu.h>\fP
40 \fBint set_menu_items(MENU *\fImenu\fB, ITEM **\fIitems\fB);\fR
42 \fBITEM **menu_items(const MENU *\fImenu\fB);\fR
44 \fBint item_count(const MENU *\fImenu\fB);\fR
46 The function \fBset_menu_items\fP changes the item pointer array of the given
47 \fImenu\fP. The array must be terminated by a \fBNULL\fP.
49 The function \fBmenu_items\fP returns the item array of the given menu.
51 The function \fBitem_count\fP returns the count of items in \fImenu\fP.
53 The function \fBmenu_items\fP returns a pointer (which may be \fBNULL\fP).
54 It does not set \fBerrno\fP.
56 The function \fBitem_count\fP returns \fBERR\fP (the general \fBcurses\fP error
57 return value) if its \fImenu\fP parameter is \fBNULL\fP.
59 The function \fBset_menu_items\fP returns one of the following codes on error:
62 The routine succeeded.
65 Routine detected an incorrect or out-of-range argument.
68 No items are connected to the menu.
71 The menu is already posted.
74 System error occurred (see \fBerrno\fP(3)).
77 \fBcurses\fP(3X), \fBmenu\fP(3X).
79 The header file \fB<menu.h>\fP automatically includes the header file
82 These routines emulate the System V menu library.
83 They were not supported on
84 Version 7 or BSD versions.
86 The SVr4 menu library documentation specifies the \fBitem_count\fP error value
87 as \-1 (which is the value of \fBERR\fP).
90 Manual pages and adaptation for new curses by Eric S. Raymond.