ncurses 5.3
[ncurses.git] / menu / m_item_use.c
1 /****************************************************************************
2  * Copyright (c) 1998,2000 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  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_item_use                                                        *
36 * Associate application data with menu items                               *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_item_use.c,v 1.12 2002/07/06 15:22:16 juergen Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_item_userptr(ITEM *item, void *userptr)
46 |   
47 |   Description   :  Set the pointer that is reserved in any item to store
48 |                    application relevant informations.  
49 |
50 |   Return Values :  E_OK               - success
51 +--------------------------------------------------------------------------*/
52 NCURSES_EXPORT(int)
53 set_item_userptr (ITEM * item, void * userptr)
54 {
55   Normalize_Item(item)->userptr = userptr;
56   RETURN( E_OK );
57 }
58
59 /*---------------------------------------------------------------------------
60 |   Facility      :  libnmenu  
61 |   Function      :  void *item_userptr(const ITEM *item)
62 |   
63 |   Description   :  Return the pointer that is reserved in any item to store
64 |                    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 item_userptr (const ITEM * item)
71 {
72   return Normalize_Item(item)->userptr;
73 }
74
75 /* m_item_use.c */