xref: /openbsd-src/lib/libmenu/m_item_nam.c (revision c7ef0cfc17afcba97172c25e1e3a943e893bc632)
1 /* $OpenBSD: m_item_nam.c,v 1.8 2023/10/17 09:52:10 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020,2021 Thomas E. Dickey                                     *
5  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *   Author:  Juergen Pfeifer, 1995,1997                                    *
34  ****************************************************************************/
35 
36 /***************************************************************************
37 * Module m_item_nam                                                        *
38 * Get menus item name and description                                      *
39 ***************************************************************************/
40 
41 #include "menu.priv.h"
42 
43 MODULE_ID("$Id: m_item_nam.c,v 1.8 2023/10/17 09:52:10 nicm Exp $")
44 
45 /*---------------------------------------------------------------------------
46 |   Facility      :  libnmenu
47 |   Function      :  char *item_name(const ITEM *item)
48 |
49 |   Description   :  Return name of menu item
50 |
51 |   Return Values :  See above; returns NULL if item is invalid
52 +--------------------------------------------------------------------------*/
MENU_EXPORT(const char *)53 MENU_EXPORT(const char *)
54 item_name(const ITEM *item)
55 {
56   T((T_CALLED("item_name(%p)"), (const void *)item));
57   returnCPtr((item) ? item->name.str : (char *)0);
58 }
59 
60 /*---------------------------------------------------------------------------
61 |   Facility      :  libnmenu
62 |   Function      :  char *item_description(const ITEM *item)
63 |
64 |   Description   :  Returns description of item
65 |
66 |   Return Values :  See above; Returns NULL if item is invalid
67 +--------------------------------------------------------------------------*/
68 MENU_EXPORT(const char *)
item_description(const ITEM * item)69 item_description(const ITEM *item)
70 {
71   T((T_CALLED("item_description(%p)"), (const void *)item));
72   returnCPtr((item) ? item->description.str : (char *)0);
73 }
74 
75 /* m_item_nam.c ends here */
76