blob: 12009edace35717667be0ba6e33b10986c7cb29f [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301'\" t
2.\"***************************************************************************
3.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. *
4.\" *
5.\" Permission is hereby granted, free of charge, to any person obtaining a *
6.\" copy of this software and associated documentation files (the *
7.\" "Software"), to deal in the Software without restriction, including *
8.\" without limitation the rights to use, copy, modify, merge, publish, *
9.\" distribute, distribute with modifications, sublicense, and/or sell *
10.\" copies of the Software, and to permit persons to whom the Software is *
11.\" furnished to do so, subject to the following conditions: *
12.\" *
13.\" The above copyright notice and this permission notice shall be included *
14.\" in all copies or substantial portions of the Software. *
15.\" *
16.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23.\" *
24.\" Except as contained in this notice, the name(s) of the above copyright *
25.\" holders shall not be used in advertising or otherwise to promote the *
26.\" sale, use or other dealings in this Software without prior written *
27.\" authorization. *
28.\"***************************************************************************
29.\"
30.\" $Id: mitem_name.3x,v 1.6 2006/11/04 17:53:40 tom Exp $
31.TH mitem_name 3X ""
32.SH NAME
33\fBmitem_name\fR - get menu item name and description fields
34.SH SYNOPSIS
35\fB#include <menu.h>\fR
36.br
37const char *item_name(const ITEM *item);
38.br
39const char *item_description(const ITEM *item);
40.br
41.SH DESCRIPTION
42The function \fBitem_name\fR returns the name part of the given item.
43.br
44The function \fBitem_description\fR returns the description part of the given
45item.
46.SH RETURN VALUE
47These routines return a pointer (which may be \fBNULL\fR).
48They do not set errno.
49.SH SEE ALSO
50\fBcurses\fR(3X), \fBmenu\fR(3X).
51.SH NOTES
52The header file \fB<menu.h>\fR automatically includes the header file
53\fB<curses.h>\fR.
54.SH PORTABILITY
55These routines emulate the System V menu library.
56They were not supported on Version 7 or BSD versions.
57.SH AUTHORS
58Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
59S. Raymond.
60.\"#
61.\"# The following sets edit modes for GNU EMACS
62.\"# Local Variables:
63.\"# mode:nroff
64.\"# fill-column:79
65.\"# End: