ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / mitem_new.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 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: mitem_new.3x,v 1.13 2015/12/05 23:42:45 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>mitem_new 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 class="no-header">mitem_new 3x</H1>
43 <PRE>
44 <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>                                             <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <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>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        ITEM *new_item(const char *name, const char *description);
58        int free_item(ITEM *item);
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>new_item</STRONG> allocates a new item and initializes
64        it from the <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers.  Please  notice
65        that  the  item  stores  only the pointers to the name and
66        description. Those pointers must be valid during the life-
67        time of the item. So you should be very careful with names
68        or descriptions allocated on the stack of some routines.
69        The function <STRONG>free_item</STRONG> de-allocates an item. Please notice
70        that  it  is  the  responsibility  of  the  application to
71        release the memory for the name or the description of  the
72        item.
73
74
75 </PRE>
76 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
77        The  function  <STRONG>new_item</STRONG>  returns  <STRONG>NULL</STRONG>  on error.  It sets
78        errno according to the function's failure:
79
80        <STRONG>E_BAD_ARGUMENT</STRONG>
81             Routine detected an incorrect or  out-of-range  argu-
82             ment.
83
84        <STRONG>E_SYSTEM_ERROR</STRONG>
85             System error occurred, e.g., malloc failure.
86
87        The function <STRONG>free_item</STRONG> returns one of the following:
88
89        <STRONG>E_OK</STRONG> The routine succeeded.
90
91        <STRONG>E_BAD_ARGUMENT</STRONG>
92             Routine  detected  an incorrect or out-of-range argu-
93             ment.
94
95        <STRONG>E_CONNECTED</STRONG>
96             Item is connected to a menu.
97
98        <STRONG>E_SYSTEM_ERROR</STRONG>
99             System error occurred (see <STRONG>errno</STRONG>).
100
101
102 </PRE>
103 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
105
106
107 </PRE>
108 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
109        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
110        file <STRONG>&lt;curses.h&gt;</STRONG>.
111
112
113 </PRE>
114 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
115        These  routines  emulate  the System V menu library.  They
116        were not supported on Version 7 or BSD versions.
117
118
119 </PRE>
120 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
121        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
122        curses by Eric S. Raymond.
123
124
125
126                                                           <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
127 </PRE>
128 <div class="nav">
129 <ul>
130 <li><a href="#h2-NAME">NAME</a></li>
131 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
132 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
133 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
134 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
135 <li><a href="#h2-NOTES">NOTES</a></li>
136 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
137 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
138 </ul>
139 </div>
140 </BODY>
141 </HTML>