doc/html/man/mitem_value.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>mitem_value</B> - set and get menu item values
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;menu.h&gt;</B>
  14        int set_item_value(ITEM *item, bool value);
  15        bool item_value(const ITEM *item);
  16
  17
  18 </PRE>
  19 <H2>DESCRIPTION</H2><PRE>
  20        If  you  turn  off  the menu option <B>O_ONEVALUE</B> (e.g., with
  21        <B>set_menu_opts</B> or <B>menu_opts_off</B>;  see  <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B>),  the
  22        menu becomes multi-valued; that is, more than one item may
  23        simultaneously be selected.
  24
  25        In a multi_valued menu, you  can  used  <B>set_item_value</B>  to
  26        select the given menu item (second argument <B>TRUE</B>) or dese-
  27        lect it (second argument <B>FALSE</B>).
  28
  29
  30 </PRE>
  31 <H2>RETURN VALUE</H2><PRE>
  32        The function <B>set_item_value</B> returns one of the following:
  33
  34        <B>E_OK</B> The routine succeeded.
  35
  36        <B>E_SYSTEM_ERROR</B>
  37             System error occurred (see <B>errno</B>).
  38
  39        <B>E_REQUEST_DENIED</B>
  40             The menu driver could not process the request.
  41
  42
  43 </PRE>
  44 <H2>SEE ALSO</H2><PRE>
  45        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
  46
  47
  48 </PRE>
  49 <H2>NOTES</H2><PRE>
  50        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
  51        file <B>&lt;curses.h&gt;</B>.
  52
  53
  54 </PRE>
  55 <H2>PORTABILITY</H2><PRE>
  56        These  routines  emulate  the System V menu library.  They
  57        were not supported on Version 7 or BSD versions.
  58
  59
  60 </PRE>
  61 <H2>AUTHORS</H2><PRE>
  62        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
  63        curses by Eric S. Raymond.
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75 </PRE>
  76 <HR>
  77 <ADDRESS>
  78 Man(1) output converted with
  79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  80 </ADDRESS>
  81 </BODY>
  82 </HTML>