Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / 9b9f5e71c18a5d2317f7871a472b47d3d7efc0c4 / . / doc / html / man / mitem_new.3x.html
blob: b4ed66765bb707de1ffbcd9aa0fcd2c2fabf5a22 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2010,2015 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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]30 * @Id: mitem_new.3x,v 1.36 2024/03/16 15:35:01 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">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>mitem_new 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]42<H1 class="no-header">mitem_new 3x 2024-03-16 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]44<STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> Library calls <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>new_item</STRONG>, <STRONG>free_item</STRONG> - create and destroy menu items
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51
52
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]53</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]54 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]55
56 <STRONG>ITEM</STRONG> <STRONG>*new_item(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>name</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>description</EM><STRONG>);</STRONG>
57 <STRONG>int</STRONG> <STRONG>free_item(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]58
59
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]60</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 The function <STRONG>new_item</STRONG> allocates a new item and initializes it from the
62 <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers. Please notice that the item stores only
63 the pointers to the name and description. Those pointers must be valid
64 during the lifetime of the item. So you should be very careful with
65 names or descriptions allocated on the stack of some routines.
66 The function <STRONG>free_item</STRONG> de-allocates an item. Please notice that it is
67 the responsibility of the application to release the memory for the
68 name or the description of the item.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]69
70
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]71</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72 The function <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error. It sets <STRONG>errno</STRONG> according
73 to the function's failure:
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]74
75 <STRONG>E_BAD_ARGUMENT</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]76 Routine detected an incorrect or out-of-range argument.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]77
78 <STRONG>E_SYSTEM_ERROR</STRONG>
79 System error occurred, e.g., malloc failure.
80
81 The function <STRONG>free_item</STRONG> returns one of the following:
82
83 <STRONG>E_OK</STRONG> The routine succeeded.
84
85 <STRONG>E_BAD_ARGUMENT</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]86 Routine detected an incorrect or out-of-range argument.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]87
88 <STRONG>E_CONNECTED</STRONG>
89 Item is connected to a menu.
90
91 <STRONG>E_SYSTEM_ERROR</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]92 System error occurred (see <STRONG>errno(3)</STRONG>).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]93
94
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]95</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
96 These routines emulate the System V menu library. They were not
97 supported on Version 7 or BSD versions.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]98
99
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]100</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
101 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
102 Raymond.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]103
104
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]105</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
106 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]107
108
109
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]110ncurses 6.5 2024-03-16 <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]111</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]112<div class="nav">
113<ul>
114<li><a href="#h2-NAME">NAME</a></li>
115<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
116<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
117<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]118<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
119<li><a href="#h2-AUTHORS">AUTHORS</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]120<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]121</ul>
122</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]123</BODY>
124</HTML>