| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | '\" t |
| 2 | .\"*************************************************************************** |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 3 | .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * |
| Amit Daniel Kachhap | e6a01f5 | 2011-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 | .\" |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 30 | .\" $Id: menu_userptr.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ |
| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 31 | .TH menu_userptr 3X "" |
| 32 | .SH NAME |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 33 | \fBmenu_userptr\fR \- associate application data with a menu item |
| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 34 | .SH SYNOPSIS |
| 35 | \fB#include <menu.h>\fR |
| 36 | .br |
| 37 | int set_menu_userptr(MENU *menu, void *userptr); |
| 38 | .br |
| 39 | void *menu_userptr(const MENU *menu); |
| 40 | .br |
| 41 | .SH DESCRIPTION |
| 42 | Every menu and every menu item has a field that can be used to hold |
| 43 | application-specific data (that is, the menu-driver code leaves it alone). |
| 44 | These functions get and set the menu user pointer field. |
| 45 | .SH RETURN VALUE |
| 46 | \fBmenu_userptr\fR returns a pointer (which may be \fBNULL\fR). |
| 47 | It does not set errno. |
| 48 | .PP |
| 49 | \fBset_menu_userptr\fP returns \fBE_OK\fP (success). |
| 50 | .SH SEE ALSO |
| 51 | \fBcurses\fR(3X), \fBmenu\fR(3X). |
| 52 | .SH NOTES |
| 53 | The header file \fB<menu.h>\fR automatically includes the header file |
| 54 | \fB<curses.h>\fR. |
| 55 | .SH PORTABILITY |
| 56 | These routines emulate the System V menu library. They were not supported on |
| 57 | Version 7 or BSD versions. |
| 58 | .PP |
| 59 | The user pointer is a void pointer. |
| 60 | We chose not to leave it as a char pointer for SVr4 compatibility. |
| 61 | .SH AUTHORS |
| 62 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric |
| 63 | S. Raymond. |