X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_userptr.3x;h=0ddf40de8cf16478294e4c014acc7e6ddd58e233;hp=2dd564fd61e8a814db4be65a8bbf927b1e23a3eb;hb=6b99a559185b3b8fad80b56bc2070b08101c33d1;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x index 2dd564fd..0ddf40de 100644 --- a/man/mitem_userptr.3x +++ b/man/mitem_userptr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2015,2018 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,10 +27,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.6 1998/11/29 01:12:47 Rick.Ohnemus Exp $ +.\" $Id: mitem_userptr.3x,v 1.13 2018/07/28 21:34:06 tom Exp $ .TH mitem_userptr 3X "" .SH NAME -\fBmitem_userptr\fR - associate application data with a menu item +\fBset_item_userptr\fP, +\fBitem_userptr\fR \- associate application data with a menu item .SH SYNOPSIS \fB#include \fR .br @@ -40,33 +41,27 @@ void *item_userptr(const ITEM *item); .br .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). +The function \fBitem_userptr\fR returns a pointer (possibly \fBNULL\fR). +It does not set errno. +.PP +The \fBset_item_userptr\fP always 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.