1.\" $NetBSD: menu_item_name.3,v 1.8 2002/10/01 19:26:59 wiz Exp $ 2.\" 3.\" Copyright (c) 1999 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd September 10, 1999 33.Dt MENU_ITEM_NAME 3 34.Os 35.Sh NAME 36.Nm item_description , 37.Nm item_name 38.Nd get item name or description 39.Sh LIBRARY 40.Lb libmenu 41.Sh SYNOPSIS 42.Fd #include \*[Lt]menu.h\*[Gt] 43.Ft char * 44.Fn item_description "ITEM *item" 45.Ft char * 46.Fn item_name "ITEM *item" 47.Sh DESCRIPTION 48The 49.Fn item_description 50.Fa menu 51function returns the description string associated with the passed 52item. 53The 54.Fn item_name 55function returns the name string associated with the passed item. 56.Sh RETURN VALUES 57The function 58.Fn item_description 59and 60.Fn item_name 61functions return NULL if the item pointer is not valid. 62.Sh SEE ALSO 63.Xr curses 3 , 64.Xr menus 3 65.Sh NOTES 66The header 67.Pa \*[Lt]menu.h\*[Gt] 68automatically includes both 69.Pa \*[Lt]curses.h\*[Gt] 70and 71.Pa \*[Lt]eti.h\*[Gt] . 72