ncurses 5.5
[ncurses.git] / doc / html / man / mitem_new.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2003 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.8 2003/10/25 20:08:57 Jared.Yanovich Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>mitem_new 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>mitem_new 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>NAME</H2><PRE>
51        <STRONG>mitem_new</STRONG> - create and destroy menu items
52
53
54 </PRE>
55 <H2>SYNOPSIS</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>DESCRIPTION</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>RETURN VALUE</H2><PRE>
77        The function <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error.
78
79        The function <STRONG>free_item</STRONG> returns one of the following:
80
81        <STRONG>E_OK</STRONG> The routine succeeded.
82
83        <STRONG>E_SYSTEM_ERROR</STRONG>
84             System error occurred (see <STRONG>errno</STRONG>).
85
86        <STRONG>E_BAD_ARGUMENT</STRONG>
87             Routine detected an incorrect or  out-of-range  argu-
88             ment.
89
90        <STRONG>E_CONNECTED</STRONG>
91             Item is connected to a menu.
92
93
94 </PRE>
95 <H2>SEE ALSO</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>
100 <H2>NOTES</H2><PRE>
101        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
102        file <STRONG>&lt;curses.h&gt;</STRONG>.
103
104
105 </PRE>
106 <H2>PORTABILITY</H2><PRE>
107        These routines emulate the System V  menu  library.   They
108        were not supported on Version 7 or BSD versions.
109
110
111 </PRE>
112 <H2>AUTHORS</H2><PRE>
113        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
114        curses by Eric S. Raymond.
115
116
117
118                                                           <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
119 </PRE>
120 <HR>
121 <ADDRESS>
122 Man(1) output converted with
123 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
124 </ADDRESS>
125 </BODY>
126 </HTML>