ncurses 6.2 - patch 20201212
[ncurses.git] / man / menu_userptr.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
4 .\" Copyright 1998-2010,2015 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 .\" $Id: menu_userptr.3x,v 1.16 2020/10/18 00:39:49 tom Exp $
32 .TH menu_userptr 3X ""
33 .SH NAME
34 \fBset_menu_userptr\fP,
35 \fBmenu_userptr\fR \- associate application data with a menu item
36 .SH SYNOPSIS
37 \fB#include <menu.h>\fR
38 .sp
39 \fBint set_menu_userptr(MENU *\fP\fImenu\fP\fB, void *\fP\fIuserptr\fP\fB);\fP
40 .br
41 \fBvoid *menu_userptr(const MENU *\fP\fImenu\fP\fB);\fP
42 .br
43 .SH DESCRIPTION
44 Every menu and every menu item has a field that can be used to hold
45 application-specific data (that is, the menu-driver code leaves it alone).
46 These functions get and set the menu user pointer field.
47 .SH RETURN VALUE
48 \fBmenu_userptr\fR returns a pointer (which may be \fBNULL\fR).
49 It does not set \fBerrno\fP.
50 .PP
51 \fBset_menu_userptr\fP returns \fBE_OK\fP (success).
52 .SH SEE ALSO
53 \fBcurses\fR(3X), \fBmenu\fR(3X).
54 .SH NOTES
55 The header file \fB<menu.h>\fR automatically includes the header file
56 \fB<curses.h>\fR.
57 .SH PORTABILITY
58 These routines emulate the System V menu library.
59 They were not supported on
60 Version 7 or BSD versions.
61 .PP
62 The user pointer is a void pointer.
63 We chose not to leave it as a char pointer for SVr4 compatibility.
64 .SH AUTHORS
65 Juergen Pfeifer.
66 Manual pages and adaptation for new curses by Eric S. Raymond.