Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / mitem_new.3x.html
blob: 58ceafa7afec319988a06bceb0d1ce7677f4286c [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]30 * @Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]42<H1 class="no-header">mitem_new 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]50<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51 <STRONG>mitem_new</STRONG> - create and destroy menu items
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]62<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63 The function <STRONG>new_item</STRONG> allocates a new item and initializes
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]70 that it is the responsibility of the application to
71 release the memory for the name or the description of the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72 item.
73
74
75</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78 errno according to the function's failure:
79
80 <STRONG>E_BAD_ARGUMENT</STRONG>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]81 Routine detected an incorrect or out-of-range argu-
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]92 Routine detected an incorrect or out-of-range argu-
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]103<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]108<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]114<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
115 These routines emulate the System V menu library. They
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]116 were not supported on Version 7 or BSD versions.
117
118
119</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]120<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
121 Juergen Pfeifer. Manual pages and adaptation for new
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]122 curses by Eric S. Raymond.
123
124
125
126 <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
127</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]140</BODY>
141</HTML>