Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / c1bcd6dd9af6865867a3d6716e4c1a45021a90e5 / . / doc / html / man / mitem_new.3x.html
blob: e069b12e74a03211618679138bf12b8120852a84 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2<!--
3 * t
4 ****************************************************************************
5 * Copyright (c) 1998-2003,2006 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.10 2006/11/04 18:16:36 tom 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. 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>SEE ALSO</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>NOTES</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>PORTABILITY</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>AUTHORS</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<HR>
129<ADDRESS>
130Man(1) output converted with
131<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
132</ADDRESS>
133</BODY>
134</HTML>