ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / mitem_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: mitem_new.3x,v 1.17 2020/03/28 19:06:28 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>mitem_new 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">mitem_new 3x</H1>
44 <PRE>
45 <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>                                                    <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>new_item</STRONG>, <STRONG>free_item</STRONG> - create and destroy menu items
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        ITEM *new_item(const char *name, const char *description);
57        int free_item(ITEM *item);
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        The  function <STRONG>new_item</STRONG> allocates a new item and initializes it from the
62        <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers.  Please notice that the item stores only
63        the pointers to the name and description.  Those pointers must be valid
64        during the lifetime of the item.  So you should be  very  careful  with
65        names or descriptions allocated on the stack of some routines.
66        The  function <STRONG>free_item</STRONG> de-allocates an item.  Please notice that it is
67        the responsibility of the application to release  the  memory  for  the
68        name or the description of the item.
69
70
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72        The  function  <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error.  It sets <STRONG>errno</STRONG> according
73        to the function's failure:
74
75        <STRONG>E_BAD_ARGUMENT</STRONG>
76             Routine detected an incorrect or out-of-range argument.
77
78        <STRONG>E_SYSTEM_ERROR</STRONG>
79             System error occurred, e.g., malloc failure.
80
81        The function <STRONG>free_item</STRONG> returns one of the following:
82
83        <STRONG>E_OK</STRONG> The routine succeeded.
84
85        <STRONG>E_BAD_ARGUMENT</STRONG>
86             Routine detected an incorrect or out-of-range argument.
87
88        <STRONG>E_CONNECTED</STRONG>
89             Item is connected to a menu.
90
91        <STRONG>E_SYSTEM_ERROR</STRONG>
92             System error occurred (see <STRONG>errno(3)</STRONG>).
93
94
95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
97
98
99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
100        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
101        <STRONG>&lt;curses.h&gt;</STRONG>.
102
103
104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
105        These  routines  emulate the System V menu library.  They were not sup-
106        ported on Version 7 or BSD versions.
107
108
109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
110        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
111        Raymond.
112
113
114
115                                                                  <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
116 </PRE>
117 <div class="nav">
118 <ul>
119 <li><a href="#h2-NAME">NAME</a></li>
120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
127 </ul>
128 </div>
129 </BODY>
130 </HTML>