xref: /openbsd/lib/libmenu/m_userptr.c (revision 404b540a)
1 /*	$OpenBSD: m_userptr.c,v 1.6 2001/01/22 18:02:06 millert Exp $	*/
2 
3 /****************************************************************************
4  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *   Author: Juergen Pfeifer <juergen.pfeifer@gmx.net> 1995,1997            *
33  ****************************************************************************/
34 
35 /***************************************************************************
36 * Module m_userptr                                                         *
37 * Associate application data with menus                                    *
38 ***************************************************************************/
39 
40 #include "menu.priv.h"
41 
42 MODULE_ID("$From: m_userptr.c,v 1.11 2000/12/10 02:16:48 tom Exp $")
43 
44 /*---------------------------------------------------------------------------
45 |   Facility      :  libnmenu
46 |   Function      :  int set_menu_userptr(MENU *menu, void *userptr)
47 |
48 |   Description   :  Set the pointer that is reserved in any menu to store
49 |                    application relevant informations.
50 |
51 |   Return Values :  E_OK         - success
52 +--------------------------------------------------------------------------*/
53 NCURSES_EXPORT(int)
54 set_menu_userptr (MENU * menu, void * userptr)
55 {
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 informations.
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   return( Normalize_Menu(menu)->userptr);
74 }
75 
76 /* m_userptr.c ends here */
77