ncurses 5.3
[ncurses.git] / doc / html / man / menu_items.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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.5 1998/11/29 01:09:56 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_items 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu_items 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu_items</STRONG>  - make and break connections between items and
48        menus
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
54        int set_menu_items(MENU *menu, ITEM **items);
55        ITEM **menu_items(const MENU *menu);
56        int item_count(const MENU *menu);
57
58
59 </PRE>
60 <H2>DESCRIPTION</H2><PRE>
61        The function <STRONG>set_menu_items</STRONG> changes the item pointer array
62        of  the  given  <EM>menu</EM>.   The  array must be terminated by a
63        <STRONG>NULL</STRONG>.
64
65        The function <STRONG>menu_items</STRONG> returns  the  item  array  of  the
66        given menu.
67
68        The  function  <STRONG>item_count</STRONG>  returns  the  count of items in
69        <EM>menu</EM>.
70
71
72 </PRE>
73 <H2>RETURN VALUES</H2><PRE>
74        The function <STRONG>menu_items</STRONG> returns <STRONG>NULL</STRONG> on error.
75
76        The function <STRONG>item_count</STRONG> returns <STRONG>ERR</STRONG>  (the  general  <STRONG>curses</STRONG>
77        error return value) on error.
78
79        The  function  <STRONG>set_menu_items</STRONG> returns one of the following
80        codes on error:
81
82        <STRONG>E_OK</STRONG> The routine succeeded.
83
84        <STRONG>E_SYSTEM_ERROR</STRONG>
85             System error occurred (see <STRONG>errno</STRONG>).
86
87        <STRONG>E_BAD_ARGUMENT</STRONG>
88             Routine detected an incorrect or  out-of-range  argu-
89             ment.
90
91        <STRONG>E_POSTED</STRONG>
92             The menu is already posted.
93
94        <STRONG>E_NOT_CONNECTED</STRONG>
95             No items are connected to the menu.
96
97
98 </PRE>
99 <H2>SEE ALSO</H2><PRE>
100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
101
102
103 </PRE>
104 <H2>NOTES</H2><PRE>
105        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
106        file <STRONG>&lt;curses.h&gt;</STRONG>.
107
108
109 </PRE>
110 <H2>PORTABILITY</H2><PRE>
111        These routines emulate the System V  menu  library.   They
112        were not supported on Version 7 or BSD versions.
113
114        The   SVr4   menu   library  documentation  specifies  the
115        <STRONG>item_count</STRONG> error value as -1 (which is the value of  <STRONG>ERR</STRONG>).
116
117
118 </PRE>
119 <H2>AUTHORS</H2><PRE>
120        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
121        curses by Eric S. Raymond.
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>