7b178b25a175ba381847fa52a2a4a2190a1a7550
[ncurses.git] / menu / m_userptr.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  ****************************************************************************/
32
33 /***************************************************************************
34 * Module m_userptr                                                         *
35 * Associate application data with menus                                    *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_userptr.c,v 1.16 2004/12/25 21:38:55 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu  
44 |   Function      :  int set_menu_userptr(MENU *menu, void *userptr)
45 |   
46 |   Description   :  Set the pointer that is reserved in any menu to store
47 |                    application relevant informations.
48 |
49 |   Return Values :  E_OK         - success
50 +--------------------------------------------------------------------------*/
51 NCURSES_EXPORT(int)
52 set_menu_userptr(MENU * menu, void *userptr)
53 {
54   T((T_CALLED("set_menu_userptr(%p,%p)"), menu, userptr));
55   Normalize_Menu(menu)->userptr = userptr;
56   RETURN(E_OK);
57 }
58
59 /*---------------------------------------------------------------------------
60 |   Facility      :  libnmenu  
61 |   Function      :  void *menu_userptr(const MENU *menu)
62 |   
63 |   Description   :  Return the pointer that is reserved in any menu to
64 |                    store application relevant informations.
65 |
66 |   Return Values :  Value of the pointer. If no such pointer has been set,
67 |                    NULL is returned
68 +--------------------------------------------------------------------------*/
69 NCURSES_EXPORT(void *)
70 menu_userptr(const MENU * menu)
71 {
72   T((T_CALLED("menu_userptr(%p)"), menu));
73   returnVoidPtr(Normalize_Menu(menu)->userptr);
74 }
75
76 /* m_userptr.c ends here */