X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_userptr.3x;h=1d492c51fccf63ed7d9c716e51b8c34d3618d664;hb=87c2c84cbd2332d6d94b12a1dcaf12ad1a51a938;hp=7b51ec50a655fe92ec9423e45fdd5a53c7ced9d2;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x index 7b51ec50..1d492c51 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-2021,2022 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,38 +28,41 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ +.\" $Id: mitem_userptr.3x,v 1.20 2022/02/12 20:02:20 tom Exp $ .TH mitem_userptr 3X "" .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 +\fB#include \fP +.sp +\fBint set_item_userptr(ITEM *\fIitem\fB, void *\fIuserptr\fB);\fR .br -int set_item_userptr(ITEM *item, void *userptr); -.br -void *item_userptr(const ITEM *item); +\fBvoid *item_userptr(const ITEM *\fIitem\fB);\fR .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. +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 SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.