X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_userptr.3x;h=afc393e08040884944b2ff0316718ab956bc7eaa;hp=1fe354183d839be70801e9d5ef2c9548cbe273ac;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/menu_userptr.3x b/man/menu_userptr.3x index 1fe35418..afc393e0 100644 --- a/man/menu_userptr.3x +++ b/man/menu_userptr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 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 * @@ -27,47 +28,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_userptr.3x,v 1.6 1998/11/29 01:11:02 Rick.Ohnemus Exp $ +.\" $Id: menu_userptr.3x,v 1.16 2020/10/18 00:39:49 tom Exp $ .TH menu_userptr 3X "" .SH NAME -\fBmenu_userptr\fR - associate application data with a menu item +\fBset_menu_userptr\fP, +\fBmenu_userptr\fR \- associate application data with a menu item .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_menu_userptr(MENU *\fP\fImenu\fP\fB, void *\fP\fIuserptr\fP\fB);\fP .br -int set_menu_userptr(MENU *menu, void *userptr); -.br -void *menu_userptr(const MENU *menu); +\fBvoid *menu_userptr(const MENU *\fP\fImenu\fP\fB);\fP .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 \fBerrno\fP. +.PP +\fBset_menu_userptr\fP returns \fBE_OK\fP (success). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.