Debian Codegraph @

upstream/debian-unstable/man3/userptr.3menu

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 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.35 2024/12/28 21:26:21 tom Exp $
31 .TH userptr 3MENU 2024-12-28 "ncurses 6.6" "Library calls"
32 .SH NAME
33 \fBset_menu_userptr\fP,
34 \fBmenu_userptr\fP \-
35 associate application data with a menu item
36 .SH SYNOPSIS
37 .nf
38 \fB#include <menu.h>
39 .PP
40 \fBint set_menu_userptr(MENU *\fImenu\fP, void *\fIuserptr\fP);
41 \fBvoid *menu_userptr(const MENU *\fImenu\fP);
42 .fi
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\fP returns a pointer (which may be
49 .IR NULL ")."
50 It does not set \fBerrno\fP.
51 .PP
52 \fBset_menu_userptr\fP returns \fBE_OK\fP (success).
53 .SH PORTABILITY
54 These routines emulate the System V menu library.
55 They were not supported on
56 Version 7 or BSD versions.
57 .PP
58 The user pointer is a void pointer.
59 We chose not to leave it as a char pointer for SVr4 compatibility.
60 .SH AUTHORS
61 Juergen Pfeifer.
62 Manual pages and adaptation for new curses by Eric S. Raymond.
63 .SH SEE ALSO
64 \fB\%ncurses\fP(3NCURSES),
65 \fB\%menu\fP(3MENU)