ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / menu_items.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2012,2015 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_items.3x,v 1.17 2020/10/24 09:00:06 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_items 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_items 3X</H1>
44 <PRE>
45 <B><A HREF="menu_items.3X.html">menu_items(3X)</A></B>                                                  <B><A HREF="menu_items.3X.html">menu_items(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>set_menu_items</B>,  <B>menu_items</B>,  <B>item_count</B>  -  make and break connections
52        between items and menus
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <B>#include</B> <B>&lt;menu.h&gt;</B>
57
58        <B>int</B> <B>set_menu_items(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>ITEM</B> <B>**</B><I>items</I><B>);</B>
59        <B>ITEM</B> <B>**menu_items(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
60        <B>int</B> <B>item_count(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        The function <B>set_menu_items</B> changes the item pointer array of the given
65        <I>menu</I>.  The array must be terminated by a <B>NULL</B>.
66
67        The function <B>menu_items</B> returns the item array of the given menu.
68
69        The function <B>item_count</B> returns the count of items in <I>menu</I>.
70
71
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The function <B>menu_items</B> returns a pointer (which may be <B>NULL</B>).  It does
74        not set <B>errno</B>.
75
76        The function <B>item_count</B> returns <B>ERR</B> (the general  <B>curses</B>  error  return
77        value) if its <I>menu</I> parameter is <B>NULL</B>.
78
79        The  function  <B>set_menu_items</B>  returns  one  of  the following codes on
80        error:
81
82        <B>E_OK</B> The routine succeeded.
83
84        <B>E_BAD_ARGUMENT</B>
85             Routine detected an incorrect or out-of-range argument.
86
87        <B>E_NOT_CONNECTED</B>
88             No items are connected to the menu.
89
90        <B>E_POSTED</B>
91             The menu is already posted.
92
93        <B>E_SYSTEM_ERROR</B>
94             System error occurred (see <B>errno(3)</B>).
95
96
97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
98        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
99
100
101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
102        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
103        <B>&lt;curses.h&gt;</B>.
104
105
106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
107        These  routines  emulate  the  System  V  menu  library.  They were not
108        supported on Version 7 or BSD versions.
109
110        The SVr4 menu library  documentation  specifies  the  <B>item_count</B>  error
111        value as -1 (which is the value of <B>ERR</B>).
112
113
114 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
115        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
116        Raymond.
117
118
119
120                                                                 <B><A HREF="menu_items.3X.html">menu_items(3X)</A></B>
121 </PRE>
122 <div class="nav">
123 <ul>
124 <li><a href="#h2-NAME">NAME</a></li>
125 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
126 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
127 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
128 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
129 <li><a href="#h2-NOTES">NOTES</a></li>
130 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
131 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
132 </ul>
133 </div>
134 </BODY>
135 </HTML>