ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_userptr.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_userptr.3x,v 1.11 2015/12/05 23:42:45 tom Exp $
31 .TH menu_userptr 3X ""
32 .SH NAME
33 \fBset_menu_userptr\fP,
34 \fBmenu_userptr\fR \- associate application data with a menu item
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .br
38 int set_menu_userptr(MENU *menu, void *userptr);
39 .br
40 void *menu_userptr(const MENU *menu);
41 .br
42 .SH DESCRIPTION
43 Every menu and every menu item has a field that can be used to hold
44 application-specific data (that is, the menu-driver code leaves it alone).
45 These functions get and set the menu user pointer field.
46 .SH RETURN VALUE
47 \fBmenu_userptr\fR returns a pointer (which may be \fBNULL\fR).
48 It does not set errno.
49 .PP
50 \fBset_menu_userptr\fP returns \fBE_OK\fP (success).
51 .SH SEE ALSO
52 \fBcurses\fR(3X), \fBmenu\fR(3X).
53 .SH NOTES
54 The header file \fB<menu.h>\fR automatically includes the header file
55 \fB<curses.h>\fR.
56 .SH PORTABILITY
57 These routines emulate the System V menu library.  They were not supported on
58 Version 7 or BSD versions.
59 .PP
60 The user pointer is a void pointer.
61 We chose not to leave it as a char pointer for SVr4 compatibility.
62 .SH AUTHORS
63 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
64 S. Raymond.