X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_userptr.3x;h=3c3feb26883ac20867213eb8dd3fe78fa9a7d1c8;hp=42e5888eeec0e9613275f364a3dd36c801a4489c;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x index 42e5888e..3c3feb26 100644 --- a/man/mitem_userptr.3x +++ b/man/mitem_userptr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 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,24 +28,26 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.10 2010/07/31 16:08:48 tom Exp $ +.\" $Id: mitem_userptr.3x,v 1.17 2020/10/18 00:36:16 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 +.sp +\fBint set_item_userptr(ITEM *\fP\fIitem\fP\fB, void *\fP\fIuserptr\fP\fB);\fP .br -int set_item_userptr(ITEM *item, void *userptr); -.br -void *item_userptr(const ITEM *item); +\fBvoid *item_userptr(const ITEM *\fP\fIitem\fP\fB);\fP .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 The function \fBitem_userptr\fR returns a pointer (possibly \fBNULL\fR). -It does not set errno. +It does not set \fBerrno\fP. .PP The \fBset_item_userptr\fP always returns \fBE_OK\fP (success). . @@ -54,17 +57,12 @@ The \fBset_item_userptr\fP always returns \fBE_OK\fP (success). 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. .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.