ncurses 5.1
[ncurses.git] / doc / html / man / menu_items.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>menu_items</B>  - make and break connections between items and
9        menus
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;menu.h&gt;</B>
15        int set_menu_items(MENU *menu, ITEM **items);
16        ITEM **menu_items(const MENU *menu);
17        int item_count(const MENU *menu);
18
19
20 </PRE>
21 <H2>DESCRIPTION</H2><PRE>
22        The function <B>set_menu_items</B> changes the item pointer array
23        of  the  given  <I>menu</I>.   The  array must be terminated by a
24        <B>NULL</B>.
25
26        The function <B>menu_items</B> returns  the  item  array  of  the
27        given menu.
28
29        The  function  <B>item_count</B>  returns  the  count of items in
30        <I>menu</I>.
31
32
33 </PRE>
34 <H2>RETURN VALUES</H2><PRE>
35        The function <B>menu_items</B> returns <B>NULL</B> on error.
36
37        The function <B>item_count</B> returns <B>ERR</B>  (the  general  <B>curses</B>
38        error return value) on error.
39
40        The  function  <B>set_menu_items</B> returns one of the following
41        codes on error:
42
43        <B>E_OK</B> The routine succeeded.
44
45        <B>E_SYSTEM_ERROR</B>
46             System error occurred (see <B>errno</B>).
47
48        <B>E_BAD_ARGUMENT</B>
49             Routine detected an incorrect or  out-of-range  argu-
50             ment.
51
52        <B>E_POSTED</B>
53             The menu is already posted.
54
55        <B>E_NOT_CONNECTED</B>
56             No items are connected to the menu.
57
58
59 </PRE>
60 <H2>SEE ALSO</H2><PRE>
61        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
62
63
64 </PRE>
65 <H2>NOTES</H2><PRE>
66        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
67        file <B>&lt;curses.h&gt;</B>.
68
69
70 </PRE>
71 <H2>PORTABILITY</H2><PRE>
72        These routines emulate the System V  menu  library.   They
73        were not supported on Version 7 or BSD versions.
74
75        The   SVr4   menu   library  documentation  specifies  the
76        <B>item_count</B> error value as -1 (which is the value of  <B>ERR</B>).
77
78
79 </PRE>
80 <H2>AUTHORS</H2><PRE>
81        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
82        curses by Eric S. Raymond.
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129 </PRE>
130 <HR>
131 <ADDRESS>
132 Man(1) output converted with
133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
134 </ADDRESS>
135 </BODY>
136 </HTML>