ncurses 6.2 - patch 20210522
[ncurses.git] / menu / m_item_nam.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2004,2010 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 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_item_nam                                                        *
36 * Get menus item name and description                                      *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_item_nam.c,v 1.18 2020/12/12 00:38:08 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  char *item_name(const ITEM *item)
46 |   
47 |   Description   :  Return name of menu item
48 |
49 |   Return Values :  See above; returns NULL if item is invalid
50 +--------------------------------------------------------------------------*/
51 MENU_EXPORT(const char *)
52 item_name(const ITEM *item)
53 {
54   T((T_CALLED("item_name(%p)"), (const void *)item));
55   returnCPtr((item) ? item->name.str : (char *)0);
56 }
57
58 /*---------------------------------------------------------------------------
59 |   Facility      :  libnmenu  
60 |   Function      :  char *item_description(const ITEM *item)
61 |   
62 |   Description   :  Returns description of item
63 |
64 |   Return Values :  See above; Returns NULL if item is invalid
65 +--------------------------------------------------------------------------*/
66 MENU_EXPORT(const char *)
67 item_description(const ITEM *item)
68 {
69   T((T_CALLED("item_description(%p)"), (const void *)item));
70   returnCPtr((item) ? item->description.str : (char *)0);
71 }
72
73 /* m_item_nam.c ends here */