1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: menu_items.3x,v 1.9 2010/12/04 18:40:45 tom Exp @
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">
40 <H1>menu_items
3x
</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF=
"menu_items.3x.html">menu_items(
3x)
</A></STRONG> <STRONG><A HREF=
"menu_items.3x.html">menu_items(
3x)
</A></STRONG>
51 <STRONG>menu_items
</STRONG> - make and break connections between items and
56 <H2>SYNOPSIS
</H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><menu.h
></STRONG>
58 int set_menu_items(MENU *menu, ITEM **items);
59 ITEM **menu_items(const MENU *menu);
60 int item_count(const MENU *menu);
64 <H2>DESCRIPTION
</H2><PRE>
65 The function
<STRONG>set_menu_items
</STRONG> changes the item pointer array
66 of the given
<EM>menu
</EM>. The array must be terminated by a
67 <STRONG>NULL
</STRONG>.
69 The function
<STRONG>menu_items
</STRONG> returns the item array of the
72 The function
<STRONG>item_count
</STRONG> returns the count of items in
77 <H2>RETURN VALUES
</H2><PRE>
78 The function
<STRONG>menu_items
</STRONG> returns a pointer (which may be
79 <STRONG>NULL
</STRONG>). It does not set errno.
81 The function
<STRONG>item_count
</STRONG> returns
<STRONG>ERR
</STRONG> (the general
<STRONG>curses
</STRONG>
82 error return value) if its
<EM>menu
</EM> parameter is
<STRONG>NULL
</STRONG>.
84 The function
<STRONG>set_menu_items
</STRONG> returns one of the following
87 <STRONG>E_OK
</STRONG> The routine succeeded.
89 <STRONG>E_BAD_ARGUMENT
</STRONG>
90 Routine detected an incorrect or out-of-range argu-
93 <STRONG>E_NOT_CONNECTED
</STRONG>
94 No items are connected to the menu.
96 <STRONG>E_POSTED
</STRONG>
97 The menu is already posted.
99 <STRONG>E_SYSTEM_ERROR
</STRONG>
100 System error occurred (see
<STRONG>errno
</STRONG>).
104 <H2>SEE ALSO
</H2><PRE>
105 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"menu.3x.html">menu(
3x)
</A></STRONG>.
110 The header file
<STRONG><menu.h
></STRONG> automatically includes the header
111 file
<STRONG><curses.h
></STRONG>.
115 <H2>PORTABILITY
</H2><PRE>
116 These routines emulate the System V menu library. They
117 were not supported on Version
7 or BSD versions.
119 The SVr4 menu library documentation specifies the
120 <STRONG>item_count
</STRONG> error value as -
1 (which is the value of
<STRONG>ERR
</STRONG>).
124 <H2>AUTHORS
</H2><PRE>
125 Juergen Pfeifer. Manual pages and adaptation for new
126 curses by Eric S. Raymond.
130 <STRONG><A HREF=
"menu_items.3x.html">menu_items(
3x)
</A></STRONG>
134 Man(
1) output converted with
135 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>