X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_userptr.3x;h=0455fe3a03801ae82b60fe22e3506fd15535213c;hp=30afd6168649fbcec28f0a96063d2bf48dcac822;hb=6b96eb711cbf58da43002ff14b66d8a52c19a731;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/menu_userptr.3x b/man/menu_userptr.3x index 30afd616..0455fe3a 100644 --- a/man/menu_userptr.3x +++ b/man/menu_userptr.3x @@ -1,27 +1,52 @@ '\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2006,2010 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.10 2010/12/04 18:40:45 tom Exp $ .TH menu_userptr 3X "" .SH NAME -\fBmenu_userptr\fR - associate application data with a menu item +\fBmenu_userptr\fR \- associate application data with a menu item .SH SYNOPSIS \fB#include \fR .br -int set_menu_userptr(MENU *menu, const void *userptr); +int set_menu_userptr(MENU *menu, void *userptr); .br -const void *menu_userptr(const MENU *menu); +void *menu_userptr(const MENU *menu); .br .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 -Except for \fBmenu_userptr\fR (which returns \fBNULL\fR on error), each -function returns one of the following: -.TP 5 -\fBE_OK\fR -The routine succeeded. -.TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +\fBmenu_userptr\fR returns a pointer (which may be \fBNULL\fR). +It does not set errno. +.PP +\fBset_menu_userptr\fP returns \fBE_OK\fP (success). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES @@ -30,15 +55,9 @@ The header file \fB\fR automatically includes the header file .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. - -The user pointer should be a void pointer. We leave it as a char pointer for -SVr4 compatibility. +.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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: