X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_userptr.3x;h=d1a2530d4bd5a7447bdba1176392362087cd5602;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=2dd564fd61e8a814db4be65a8bbf927b1e23a3eb;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x index 2dd564fd..d1a2530d 100644 --- a/man/mitem_userptr.3x +++ b/man/mitem_userptr.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2022,2023 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,46 +27,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.6 1998/11/29 01:12:47 Rick.Ohnemus Exp $ -.TH mitem_userptr 3X "" +.\" $Id: mitem_userptr.3x,v 1.32 2023/11/25 13:58:47 tom Exp $ +.TH mitem_userptr 3X 2023-11-25 "ncurses 6.4" "Library calls" .SH NAME -\fBmitem_userptr\fR - associate application data with a menu item +\fBset_item_userptr\fP, +\fBitem_userptr\fP \- +associate application data with a menu item .SH SYNOPSIS -\fB#include \fR -.br -int set_item_userptr(ITEM *item, void *userptr); -.br -void *item_userptr(const ITEM *item); -.br +.nf +\fB#include +.PP +\fBint set_item_userptr(ITEM *\fIitem\fP, void *\fIuserptr\fP); +\fBvoid *item_userptr(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION 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 +(that is, the menu-driver code leaves it alone). +These functions get and set that field. .SH RETURN VALUE -Except for \fBitem_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). -.SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The function \fBitem_userptr\fP returns a pointer (possibly \fBNULL\fP). +It does not set \fBerrno\fP. +.PP +The \fBset_item_userptr\fP always returns \fBE_OK\fP (success). .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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)