| .\"*************************************************************************** |
| .\" Copyright 2018-2023,2024 Thomas E. Dickey * |
| .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * |
| .\" * |
| .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| .\" copy of this software and associated documentation files (the * |
| .\" "Software"), to deal in the Software without restriction, including * |
| .\" without limitation the rights to use, copy, modify, merge, publish, * |
| .\" distribute, distribute with modifications, sublicense, and/or sell * |
| .\" copies of the Software, and to permit persons to whom the Software is * |
| .\" furnished to do so, subject to the following conditions: * |
| .\" * |
| .\" The above copyright notice and this permission notice shall be included * |
| .\" in all copies or substantial portions of the Software. * |
| .\" * |
| .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| .\" * |
| .\" Except as contained in this notice, the name(s) of the above copyright * |
| .\" holders shall not be used in advertising or otherwise to promote the * |
| .\" sale, use or other dealings in this Software without prior written * |
| .\" authorization. * |
| .\"*************************************************************************** |
| .\" |
| .\" $Id: menu_userptr.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ |
| .TH menu_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" |
| .SH NAME |
| \fBset_menu_userptr\fP, |
| \fBmenu_userptr\fP \- |
| associate application data with a menu item |
| .SH SYNOPSIS |
| .nf |
| \fB#include <menu.h> |
| .PP |
| \fBint set_menu_userptr(MENU *\fImenu\fP, void *\fIuserptr\fP); |
| \fBvoid *menu_userptr(const MENU *\fImenu\fP); |
| .fi |
| .SH DESCRIPTION |
| Every menu and every menu item has a field that can be used to hold |
| application-specific data (that is, the menu-driver code leaves it alone). |
| These functions get and set the menu user pointer field. |
| .SH RETURN VALUE |
| \fBmenu_userptr\fP returns a pointer (which may be \fBNULL\fP). |
| It does not set \fBerrno\fP. |
| .PP |
| \fBset_menu_userptr\fP returns \fBE_OK\fP (success). |
| .SH PORTABILITY |
| These routines emulate the System V menu library. |
| They were not supported on |
| Version 7 or BSD versions. |
| .PP |
| The user pointer is a void pointer. |
| We chose not to leave it as a char pointer for SVr4 compatibility. |
| .SH AUTHORS |
| Juergen Pfeifer. |
| Manual pages and adaptation for new curses by Eric S. Raymond. |
| .SH SEE ALSO |
| \fB\%curses\fP(3X), |
| \fB\%menu\fP(3X) |