ncurses 4.2
[ncurses.git] / Ada95 / html / mitem_value.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>mitem_value</STRONG> - set and get menu item values
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
10        int set_item_value(ITEM *item, bool value);
11        bool item_value(const ITEM *item);
12
13
14 </PRE>
15 <H2>DESCRIPTION</H2><PRE>
16        If  you  turn  off  the menu option <STRONG>O_ONEVALUE</STRONG> (e.g., with
17        <STRONG>set_menu_opts</STRONG> or <STRONG>menu_opts_off</STRONG>;  see  <STRONG><A HREF="menu_opts.3x.html">menu_opts(3X)</A></STRONG>),  the
18        menu becomes multi-valued; that is, more than one item may
19        simultaneously be selected.
20
21        In a multi_valued menu, you  can  used  <STRONG>set_item_value</STRONG>  to
22        select the given menu item (second argument <STRONG>TRUE</STRONG>) or dese-
23        lect it (second argument <STRONG>FALSE</STRONG>).
24
25
26 </PRE>
27 <H2>RETURN VALUE</H2><PRE>
28        The function <STRONG>set_item_value</STRONG> returns one of the following:
29
30        <STRONG>E_OK</STRONG> The routine succeeded.
31
32        <STRONG>E_SYSTEM_ERROR</STRONG>
33             System error occurred (see <STRONG>errno</STRONG>).
34
35        <STRONG>E_REQUEST_DENIED</STRONG>
36             The menu driver could not process the request.
37
38
39 </PRE>
40 <H2>SEE ALSO</H2><PRE>
41        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3X)</A></STRONG>.
42
43
44 </PRE>
45 <H2>NOTES</H2><PRE>
46        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
47        file <STRONG>&lt;curses.h&gt;</STRONG>.
48
49
50 </PRE>
51 <H2>PORTABILITY</H2><PRE>
52        These  routines  emulate  the System V menu library.  They
53        were not supported on Version 7 or BSD versions.
54
55
56 </PRE>
57 <H2>AUTHORS</H2><PRE>
58        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
59        curses by Eric S. Raymond.
60
61
62
63
64
65
66
67
68
69
70 </PRE>
71 </BODY>
72 </HTML>