blob: fd73c6b6df245e540a4c972aea1f2a8e94cc76de [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +01004 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05305 * *
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 +010030 * @Id: mitem_name.3x,v 1.8 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053031-->
Steve Kondikae271bc2015-11-15 02:50:53 +010032<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053033<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010035<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 +053037<TITLE>mitem_name 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 +010042<H1 class="no-header">mitem_name 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053044<STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
45
46
47
48
49</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010050<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053051 <STRONG>mitem_name</STRONG> - get menu item name and description fields
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010055<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053056 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57 const char *item_name(const ITEM *item);
58 const char *item_description(const ITEM *item);
59
60
61</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010062<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053063 The function <STRONG>item_name</STRONG> returns the name part of the given
64 item.
65 The function <STRONG>item_description</STRONG> returns the description part
66 of the given item.
67
68
69</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010070<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053071 These routines return a pointer (which may be <STRONG>NULL</STRONG>). They
72 do not set errno.
73
74
75</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010076<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053077 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
78
79
80</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010081<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053082 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
83 file <STRONG>&lt;curses.h&gt;</STRONG>.
84
85
86</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010087<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053088 These routines emulate the System V menu library. They
89 were not supported on Version 7 or BSD versions.
90
91
92</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010093<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053094 Juergen Pfeifer. Manual pages and adaptation for new
95 curses by Eric S. Raymond.
96
97
98
99 <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG>
100</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100101<div class="nav">
102<ul>
103<li><a href="#h2-NAME">NAME</a></li>
104<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
105<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
106<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
107<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
108<li><a href="#h2-NOTES">NOTES</a></li>
109<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
110<li><a href="#h2-AUTHORS">AUTHORS</a></li>
111</ul>
112</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530113</BODY>
114</HTML>