summaryrefslogtreecommitdiff
path: root/lib/libmenu/menu_items.3
blob: ead8bd96af1f3669bb316480bda2a06fe4224eef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
'\" t
.\" $OpenBSD: menu_items.3,v 1.3 1997/12/14 23:19:34 millert Exp $
.TH menu_items 3 ""
.SH NAME
\fBmenu_items\fR - make and break connections between items and menus
.SH SYNOPSIS
\fB#include <menu.h>\fR
.br
int set_menu_items(MENU *menu, ITEM **items);
.br
ITEM **menu_items(const MENU *menu);
.br
int item_count(const MENU *menu);
.br
.SH DESCRIPTION
The function \fBset_menu_items\fR changes the item pointer array of the given
\fImenu\fR.  The array must be terminated by a \fBNULL\fR.

The function \fBmenu_items\fR returns the item array of the given menu.

The function \fBitem_count\fR returns the count of items in \fImenu\fR.
.SH RETURN VALUES
The function \fBmenu_items\fR returns \fBNULL\fR on error.

The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error
return value) on error.

The function \fBset_menu_items\fR returns one of the following codes on error:
.TP 5
\fBE_OK\fR
The routine succeeded.
.TP 5
\fBE_SYSTEM_ERROR\fR
System error occurred (see \fBerrno\fR).
.TP 5
\fBE_BAD_ARGUMENT\fR
Routine detected an incorrect or out-of-range argument.
.TP 5
\fBE_POSTED\fR
The menu is already posted.
.TP 5
\fBE_NOT_CONNECTED\fR
No items are connected to the menu.
.SH SEE ALSO
\fBcurses\fR(3), \fBmenu\fR(3).
.SH NOTES
The header file \fB<menu.h>\fR automatically includes the header file
\fB<curses.h>\fR.
.SH PORTABILITY
These routines emulate the System V menu library.  They were not supported on
Version 7 or BSD versions.

The SVr4 menu library documentation specifies the \fBitem_count\fR error value
as -1 (which is the value of \fBERR\fR).
.SH AUTHORS
Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
S. Raymond.
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: