xref: /freebsd/contrib/ncurses/man/mitem_name.3x (revision 77a1348b3c1cfe8547be49a121b56299a1e18b69)
t
***************************************************************************
Copyright 2018,2020 Thomas E. Dickey *
Copyright 1998-2010,2015 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: mitem_name.3x,v 1.11 2020/02/02 23:34:34 tom Exp $
mitem_name 3X ""
NAME
item_name, item_description - get menu item name and description fields
SYNOPSIS
#include <menu.h>

const char *item_name(const ITEM *item);

const char *item_description(const ITEM *item);

DESCRIPTION
The function item_name returns the name part of the given item.

The function item_description returns the description part of the given item.

RETURN VALUE
These routines return a pointer (which may be NULL). They do not set errno.
SEE ALSO
curses(3X), menu(3X).
NOTES
The header file <menu.h> automatically includes the header file <curses.h>.
PORTABILITY
These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.