doc/html/man/menu_new.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2015 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_new.3x,v 1.35 2024/03/16 15:35:01 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 https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>menu_new 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">menu_new 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>                     Library calls                    <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>new_menu</STRONG>, <STRONG>free_menu</STRONG> - create and destroy menus
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  55
  56        <STRONG>MENU</STRONG> <STRONG>*new_menu(ITEM</STRONG> <STRONG>**</STRONG><EM>items</EM><STRONG>);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>free_menu(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        The  function <STRONG>new_menu</STRONG> creates a new menu connected to a specified item
  62        pointer array (which must be <STRONG>NULL</STRONG>-terminated).
  63
  64        The function <STRONG>free_menu</STRONG> disconnects <EM>menu</EM> from its item array  and  frees
  65        the storage allocated for the menu.
  66
  67
  68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  69        The  function  <STRONG>new_menu</STRONG> returns <STRONG>NULL</STRONG> on error.  It sets <STRONG>errno</STRONG> according
  70        to the function's failure:
  71
  72        <STRONG>E_NOT_CONNECTED</STRONG>
  73             No items are connected to the menu.
  74
  75        <STRONG>E_SYSTEM_ERROR</STRONG>
  76             System error occurred, e.g., malloc failure.
  77
  78        The function <STRONG>free_menu</STRONG> returns one of the following:
  79
  80        <STRONG>E_OK</STRONG> The routine succeeded.
  81
  82        <STRONG>E_SYSTEM_ERROR</STRONG>
  83             System error occurred (see <STRONG>errno(3)</STRONG>).
  84
  85        <STRONG>E_BAD_ARGUMENT</STRONG>
  86             Routine detected an incorrect or out-of-range argument.
  87
  88        <STRONG>E_POSTED</STRONG>
  89             The menu has already been posted.
  90
  91
  92 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  93        These routines emulate the  System  V  menu  library.   They  were  not
  94        supported on Version 7 or BSD versions.
  95
  96
  97 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  98        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
  99        Raymond.
 100
 101
 102 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
 104
 105
 106
 107 ncurses 6.4                       2024-03-16                      <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG>
 108 </PRE>
 109 <div class="nav">
 110 <ul>
 111 <li><a href="#h2-NAME">NAME</a></li>
 112 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 113 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 114 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 115 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 116 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 117 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 118 </ul>
 119 </div>
 120 </BODY>
 121 </HTML>