2 ****************************************************************************
3 * Copyright 2018-2023,2024 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 ****************************************************************************
30 * @Id: menu_items.3x,v 1.34 2024/03/16 15:35:01 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_items 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">menu_items 3x 2024-03-16 ncurses 6.5 Library calls</H1>
44 <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_menu_items</STRONG>, <STRONG>menu_items</STRONG>, <STRONG>item_count</STRONG> - make and break connections
51 between items and menus
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>set_menu_items(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>ITEM</STRONG> <STRONG>**</STRONG><EM>items</EM><STRONG>);</STRONG>
58 <STRONG>ITEM</STRONG> <STRONG>**menu_items(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>item_count(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63 The function <STRONG>set_menu_items</STRONG> changes the item pointer array of the given
64 <EM>menu</EM>. The array must be terminated by a <STRONG>NULL</STRONG>.
66 The function <STRONG>menu_items</STRONG> returns the item array of the given menu.
68 The function <STRONG>item_count</STRONG> returns the count of items in <EM>menu</EM>.
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72 The function <STRONG>menu_items</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does
73 not set <STRONG>errno</STRONG>.
75 The function <STRONG>item_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> error return
76 value) if its <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
78 The function <STRONG>set_menu_items</STRONG> returns one of the following codes on
81 <STRONG>E_OK</STRONG> The routine succeeded.
83 <STRONG>E_BAD_ARGUMENT</STRONG>
84 Routine detected an incorrect or out-of-range argument.
86 <STRONG>E_NOT_CONNECTED</STRONG>
87 No items are connected to the menu.
89 <STRONG>E_POSTED</STRONG>
90 The menu is already posted.
92 <STRONG>E_SYSTEM_ERROR</STRONG>
93 System error occurred (see <STRONG>errno(3)</STRONG>).
96 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
97 These routines emulate the System V menu library. They were not
98 supported on Version 7 or BSD versions.
100 The SVr4 menu library documentation specifies the <STRONG>item_count</STRONG> error
101 value as -1 (which is the value of <STRONG>ERR</STRONG>).
104 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
105 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
109 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
110 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
114 ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
118 <li><a href="#h2-NAME">NAME</a></li>
119 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
120 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
124 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>