Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / menu_userptr.3x
blob: 292bbd6b85e8028a959f50e67ed02d50b2a66e56 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]30.\" $Id: menu_userptr.3x,v 1.33 2024/03/16 15:35:01 tom Exp $
31.TH menu_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]33\fBset_menu_userptr\fP,
34\fBmenu_userptr\fP \-
35associate application data with a menu item
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]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
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43.SH DESCRIPTION
44Every menu and every menu item has a field that can be used to hold
45application-specific data (that is, the menu-driver code leaves it alone).
46These functions get and set the menu user pointer field.
47.SH RETURN VALUE
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]48\fBmenu_userptr\fP returns a pointer (which may be \fBNULL\fP).
49It does not set \fBerrno\fP.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50.PP
51\fBset_menu_userptr\fP returns \fBE_OK\fP (success).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53These routines emulate the System V menu library.
54They were not supported on
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55Version 7 or BSD versions.
56.PP
57The user pointer is a void pointer.
58We chose not to leave it as a char pointer for SVr4 compatibility.
59.SH AUTHORS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]60Juergen Pfeifer.
61Manual pages and adaptation for new curses by Eric S. Raymond.
62.SH SEE ALSO
63\fB\%curses\fP(3X),
64\fB\%menu\fP(3X)