ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_items.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2012,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_items.3x,v 1.11 2015/12/05 23:47:32 tom Exp $
31 .TH menu_items 3X ""
32 .SH NAME
33 \fBset_menu_items\fR,
34 \fBmenu_items\fR,
35 \fBitem_count\fP \- make and break connections between items and menus
36 .SH SYNOPSIS
37 \fB#include <menu.h>\fR
38 .br
39 int set_menu_items(MENU *menu, ITEM **items);
40 .br
41 ITEM **menu_items(const MENU *menu);
42 .br
43 int item_count(const MENU *menu);
44 .br
45 .SH DESCRIPTION
46 The function \fBset_menu_items\fR changes the item pointer array of the given
47 \fImenu\fR.  The array must be terminated by a \fBNULL\fR.
48 .PP
49 The function \fBmenu_items\fR returns the item array of the given menu.
50 .PP
51 The function \fBitem_count\fR returns the count of items in \fImenu\fR.
52 .SH RETURN VALUE
53 The function \fBmenu_items\fR returns a pointer (which may be \fBNULL\fR).
54 It does not set errno.
55 .PP
56 The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error
57 return value) if its \fImenu\fP parameter is \fBNULL\fP.
58 .PP
59 The function \fBset_menu_items\fR returns one of the following codes on error:
60 .TP 5
61 .B E_OK
62 The routine succeeded.
63 .TP 5
64 .B E_BAD_ARGUMENT
65 Routine detected an incorrect or out-of-range argument.
66 .TP 5
67 .B E_NOT_CONNECTED
68 No items are connected to the menu.
69 .TP 5
70 .B E_POSTED
71 The menu is already posted.
72 .TP 5
73 .B E_SYSTEM_ERROR
74 System error occurred (see \fBerrno\fR).
75 .
76 .SH SEE ALSO
77 \fBcurses\fR(3X), \fBmenu\fR(3X).
78 .SH NOTES
79 The header file \fB<menu.h>\fR automatically includes the header file
80 \fB<curses.h>\fR.
81 .SH PORTABILITY
82 These routines emulate the System V menu library.  They were not supported on
83 Version 7 or BSD versions.
84 .PP
85 The SVr4 menu library documentation specifies the \fBitem_count\fR error value
86 as \-1 (which is the value of \fBERR\fR).
87 .SH AUTHORS
88 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
89 S. Raymond.