3 ****************************************************************************
4 * Copyright 2018,2020 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: menu_userptr.3x,v 1.14 2020/03/28 19:06:28 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_userptr 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">menu_userptr 3x</H1>
45 <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>set_menu_userptr</STRONG>, <STRONG>menu_userptr</STRONG> - associate application data with a menu
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
57 int set_menu_userptr(MENU *menu, void *userptr);
58 void *menu_userptr(const MENU *menu);
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62 Every menu and every menu item has a field that can be used to hold
63 application-specific data (that is, the menu-driver code leaves it
64 alone). These functions get and set the menu user pointer field.
67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
68 <STRONG>menu_userptr</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does not set
69 <STRONG>errno</STRONG>.
71 <STRONG>set_menu_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
74 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
75 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
78 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
79 The header file <STRONG><menu.h></STRONG> automatically includes the header file
80 <STRONG><curses.h></STRONG>.
83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
84 These routines emulate the System V menu library. They were not sup-
85 ported on Version 7 or BSD versions.
87 The user pointer is a void pointer. We chose not to leave it as a char
88 pointer for SVr4 compatibility.
91 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
92 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
97 <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG>
101 <li><a href="#h2-NAME">NAME</a></li>
102 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
103 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
104 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
105 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
106 <li><a href="#h2-NOTES">NOTES</a></li>
107 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
108 <li><a href="#h2-AUTHORS">AUTHORS</a></li>