ncurses 6.2 - patch 20200314
[ncurses.git] / menu / m_userptr.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_userptr                                                         *
36 * Associate application data with menus                                    *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_userptr.c,v 1.19 2020/02/02 23:34:34 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu
45 |   Function      :  int set_menu_userptr(MENU *menu, void *userptr)
46 |
47 |   Description   :  Set the pointer that is reserved in any menu to store
48 |                    application relevant information.
49 |
50 |   Return Values :  E_OK         - success
51 +--------------------------------------------------------------------------*/
52 NCURSES_EXPORT(int)
53 set_menu_userptr(MENU * menu, void *userptr)
54 {
55   T((T_CALLED("set_menu_userptr(%p,%p)"), (void *)menu, (void *)userptr));
56   Normalize_Menu(menu)->userptr = userptr;
57   RETURN(E_OK);
58 }
59
60 /*---------------------------------------------------------------------------
61 |   Facility      :  libnmenu
62 |   Function      :  void *menu_userptr(const MENU *menu)
63 |
64 |   Description   :  Return the pointer that is reserved in any menu to
65 |                    store application relevant information.
66 |
67 |   Return Values :  Value of the pointer. If no such pointer has been set,
68 |                    NULL is returned
69 +--------------------------------------------------------------------------*/
70 NCURSES_EXPORT(void *)
71 menu_userptr(const MENU * menu)
72 {
73   T((T_CALLED("menu_userptr(%p)"), (const void *)menu));
74   returnVoidPtr(Normalize_Menu(menu)->userptr);
75 }
76
77 /* m_userptr.c ends here */