blob: 67d6ecd425037015ea9f8fd5d3ed723852b87f82 [file] [log] [blame]
Patrick Georgi3b77b722011-07-07 15:41:53 +02001/****************************************************************************
2 * Copyright (c) 1998-2004,2010 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
40MODULE_ID("$Id: m_userptr.c,v 1.17 2010/01/23 21:20:10 tom Exp $")
41
42/*---------------------------------------------------------------------------
Stefan Reinauere11835e2011-10-31 12:54:00 -070043| Facility : libnmenu
Patrick Georgi3b77b722011-07-07 15:41:53 +020044| Function : int set_menu_userptr(MENU *menu, void *userptr)
Stefan Reinauere11835e2011-10-31 12:54:00 -070045|
Patrick Georgi3b77b722011-07-07 15:41:53 +020046| Description : Set the pointer that is reserved in any menu to store
47| application relevant informations.
48|
49| Return Values : E_OK - success
50+--------------------------------------------------------------------------*/
51NCURSES_EXPORT(int)
52set_menu_userptr(MENU * menu, void *userptr)
53{
54 T((T_CALLED("set_menu_userptr(%p,%p)"), (void *)menu, (void *)userptr));
55 Normalize_Menu(menu)->userptr = userptr;
56 RETURN(E_OK);
57}
58
59/*---------------------------------------------------------------------------
Stefan Reinauere11835e2011-10-31 12:54:00 -070060| Facility : libnmenu
Patrick Georgi3b77b722011-07-07 15:41:53 +020061| Function : void *menu_userptr(const MENU *menu)
Stefan Reinauere11835e2011-10-31 12:54:00 -070062|
Patrick Georgi3b77b722011-07-07 15:41:53 +020063| 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+--------------------------------------------------------------------------*/
69NCURSES_EXPORT(void *)
70menu_userptr(const MENU * menu)
71{
72 T((T_CALLED("menu_userptr(%p)"), (const void *)menu));
73 returnVoidPtr(Normalize_Menu(menu)->userptr);
74}
75
76/* m_userptr.c ends here */