\" $NetBSD: menu_item_name.3,v 1.10 2017/07/03 21:32:50 wiz Exp $

\" $NetBSD: menu_item_name.3,v 1.10 2017/07/03 21:32:50 wiz Exp $
\"
\" Copyright (c) 1999
\" Brett Lymn - [email protected], [email protected]
\"
\" This code is donated to The NetBSD Foundation by the author.
\"
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\" 3. The name of the Author may not be used to endorse or promote
\" products derived from this software without specific prior written
\" permission.
\"
\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\" SUCH DAMAGE.
\"
Dd September 10, 1999
Dt MENU_ITEM_NAME 3
Os
Sh NAME
Nm item_description ,
Nm item_name
Nd get item name or description
Sh LIBRARY
Lb libmenu
Sh SYNOPSIS
In menu.h
Ft char *
Fn item_description "ITEM *item"
Ft char *
Fn item_name "ITEM *item"
Sh DESCRIPTION
The
Fn item_description
Fa menu
function returns the description string associated with the passed
item.
The
Fn item_name
function returns the name string associated with the passed item.
Sh RETURN VALUES
The function
Fn item_description
and
Fn item_name
functions return NULL if the item pointer is not valid.
Sh SEE ALSO
Xr curses 3 ,
Xr menus 3
Sh NOTES
The header
Pa <menu.h>
automatically includes both
Pa <curses.h>
and
Pa <eti.h> .