ncurses 6.1 - patch 20190518
[ncurses.git] / doc / html / man / menu_items.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_items.3x,v 1.13 2019/01/20 20:32:23 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_items 3x</H1>
43 <PRE>
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>
45
46
47
48
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
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_menu_items(MENU *menu, ITEM **items);
57        ITEM **menu_items(const MENU *menu);
58        int item_count(const MENU *menu);
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        The function <STRONG>set_menu_items</STRONG> changes the item pointer array of the given
63        <EM>menu</EM>.  The array must be terminated by a <STRONG>NULL</STRONG>.
64
65        The function <STRONG>menu_items</STRONG> returns the item array of the given menu.
66
67        The function <STRONG>item_count</STRONG> returns the count of items in <EM>menu</EM>.
68
69
70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
71        The function <STRONG>menu_items</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>).  It does
72        not set errno.
73
74        The function <STRONG>item_count</STRONG> returns <STRONG>ERR</STRONG> (the general  <STRONG>curses</STRONG>  error  return
75        value) if its <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
76
77        The  function  <STRONG>set_menu_items</STRONG>  returns  one  of  the following codes on
78        error:
79
80        <STRONG>E_OK</STRONG> The routine succeeded.
81
82        <STRONG>E_BAD_ARGUMENT</STRONG>
83             Routine detected an incorrect or out-of-range argument.
84
85        <STRONG>E_NOT_CONNECTED</STRONG>
86             No items are connected to the menu.
87
88        <STRONG>E_POSTED</STRONG>
89             The menu is already posted.
90
91        <STRONG>E_SYSTEM_ERROR</STRONG>
92             System error occurred (see <STRONG>errno(3)</STRONG>).
93
94
95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
97
98
99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
100        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
101        <STRONG>&lt;curses.h&gt;</STRONG>.
102
103
104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
105        These  routines  emulate the System V menu library.  They were not sup-
106        ported on Version 7 or BSD versions.
107
108        The SVr4 menu library  documentation  specifies  the  <STRONG>item_count</STRONG>  error
109        value as -1 (which is the value of <STRONG>ERR</STRONG>).
110
111
112 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
113        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
114        Raymond.
115
116
117
118                                                                 <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
119 </PRE>
120 <div class="nav">
121 <ul>
122 <li><a href="#h2-NAME">NAME</a></li>
123 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
124 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
125 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
126 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
127 <li><a href="#h2-NOTES">NOTES</a></li>
128 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
129 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
130 </ul>
131 </div>
132 </BODY>
133 </HTML>