doc/html/man/menu_items.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2010,2012 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.10 2012/11/03 23:03:59 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 http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>menu_items 3x</TITLE>
  38 <link rev=made 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>menu_items 3x</H1>
  43 <HR>
  44 <PRE>
  45 <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>                                           <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE>
  51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  52        <STRONG>menu_items</STRONG>  - make and break connections between items and
  53        menus
  54
  55
  56 </PRE>
  57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  58        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  59        int set_menu_items(MENU *menu, ITEM **items);
  60        ITEM **menu_items(const MENU *menu);
  61        int item_count(const MENU *menu);
  62
  63
  64 </PRE>
  65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The function <STRONG>set_menu_items</STRONG> changes the item pointer array
  67        of  the  given  <EM>menu</EM>.   The  array must be terminated by a
  68        <STRONG>NULL</STRONG>.
  69
  70        The function <STRONG>menu_items</STRONG> returns  the  item  array  of  the
  71        given menu.
  72
  73        The  function  <STRONG>item_count</STRONG>  returns  the  count of items in
  74        <EM>menu</EM>.
  75
  76
  77 </PRE>
  78 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  79        The function <STRONG>menu_items</STRONG> returns a pointer  (which  may  be
  80        <STRONG>NULL</STRONG>).  It does not set errno.
  81
  82        The  function  <STRONG>item_count</STRONG>  returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG>
  83        error return value) if its <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
  84
  85        The function <STRONG>set_menu_items</STRONG> returns one of  the  following
  86        codes on error:
  87
  88        <STRONG>E_OK</STRONG> The routine succeeded.
  89
  90        <STRONG>E_BAD_ARGUMENT</STRONG>
  91             Routine  detected  an incorrect or out-of-range argu-
  92             ment.
  93
  94        <STRONG>E_NOT_CONNECTED</STRONG>
  95             No items are connected to the menu.
  96
  97        <STRONG>E_POSTED</STRONG>
  98             The menu is already posted.
  99
 100        <STRONG>E_SYSTEM_ERROR</STRONG>
 101             System error occurred (see <STRONG>errno</STRONG>).
 102
 103
 104 </PRE>
 105 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 106        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 107
 108
 109 </PRE>
 110 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 111        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
 112        file <STRONG>&lt;curses.h&gt;</STRONG>.
 113
 114
 115 </PRE>
 116 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 117        These  routines  emulate  the System V menu library.  They
 118        were not supported on Version 7 or BSD versions.
 119
 120        The  SVr4  menu  library   documentation   specifies   the
 121        <STRONG>item_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
 122
 123
 124 </PRE>
 125 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 126        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 127        curses by Eric S. Raymond.
 128
 129
 130
 131                                                          <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
 132 </PRE>
 133 <div class="nav">
 134 <ul>
 135 <li><a href="#h2-NAME">NAME</a></li>
 136 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 137 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 138 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 140 <li><a href="#h2-NOTES">NOTES</a></li>
 141 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 142 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 143 </ul>
 144 </div>
 145 </BODY>
 146 </HTML>