86603d1abe15f034e135b5e8a7f8301360b7117b
[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 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.7 1998/11/29 01:11:38 Rick.Ohnemus 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
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>mitem_new</STRONG> - create and destroy menu items
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        ITEM *new_item(const char *name, const char *description);
54        int free_item(ITEM *item);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The function <STRONG>new_item</STRONG> allocates a new item and initializes
60        it  from  the <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers. Please notice
61        that the item stores only the pointers  to  the  name  and
62        description. Those pointers must be valid during the life-
63        time of the item. So you  should  be  very  carefull  with
64        names  or descriptions allocated on the stack of some rou-
65        tines.
66        The function <STRONG>free_item</STRONG> de-allocates an item. Please notice
67        that  it  is  the  responsibility  of  the  application to
68        release the memory for the name or the description of  the
69        item.
70
71
72 </PRE>
73 <H2>RETURN VALUE</H2><PRE>
74        The function <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error.
75
76        The function <STRONG>free_item</STRONG> returns one of the following:
77
78        <STRONG>E_OK</STRONG> The routine succeeded.
79
80        <STRONG>E_SYSTEM_ERROR</STRONG>
81             System error occurred (see <STRONG>errno</STRONG>).
82
83        <STRONG>E_BAD_ARGUMENT</STRONG>
84             Routine  detected  an incorrect or out-of-range argu-
85             ment.
86
87        <STRONG>E_CONNECTED</STRONG>
88             Item is connected to a menu.
89
90
91 </PRE>
92 <H2>SEE ALSO</H2><PRE>
93        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
94
95
96 </PRE>
97 <H2>NOTES</H2><PRE>
98        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
99        file <STRONG>&lt;curses.h&gt;</STRONG>.
100
101
102 </PRE>
103 <H2>PORTABILITY</H2><PRE>
104        These  routines  emulate  the System V menu library.  They
105        were not supported on Version 7 or BSD versions.
106
107
108 </PRE>
109 <H2>AUTHORS</H2><PRE>
110        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
111        curses by Eric S. Raymond.
112
113
114 </PRE>
115 <HR>
116 <ADDRESS>
117 Man(1) output converted with
118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
119 </ADDRESS>
120 </BODY>
121 </HTML>