man/mitem_userptr.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   5 .\"                                                                          *
   6 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   7 .\" copy of this software and associated documentation files (the            *
   8 .\" "Software"), to deal in the Software without restriction, including      *
   9 .\" without limitation the rights to use, copy, modify, merge, publish,      *
  10 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  11 .\" copies of the Software, and to permit persons to whom the Software is    *
  12 .\" furnished to do so, subject to the following conditions:                 *
  13 .\"                                                                          *
  14 .\" The above copyright notice and this permission notice shall be included  *
  15 .\" in all copies or substantial portions of the Software.                   *
  16 .\"                                                                          *
  17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24 .\"                                                                          *
  25 .\" Except as contained in this notice, the name(s) of the above copyright   *
  26 .\" holders shall not be used in advertising or otherwise to promote the     *
  27 .\" sale, use or other dealings in this Software without prior written       *
  28 .\" authorization.                                                           *
  29 .\"***************************************************************************
  30 .\"
  31 .\" $Id: mitem_userptr.3x,v 1.20 2022/02/12 20:02:20 tom Exp $
  32 .TH mitem_userptr 3X ""
  33 .SH NAME
  34 \fBset_item_userptr\fP,
  35 \fBitem_userptr\fP \- associate application data with a menu item
  36 .SH SYNOPSIS
  37 \fB#include <menu.h>\fP
  38 .sp
  39 \fBint set_item_userptr(ITEM *\fIitem\fB, void *\fIuserptr\fB);\fR
  40 .br
  41 \fBvoid *item_userptr(const ITEM *\fIitem\fB);\fR
  42 .br
  43 .SH DESCRIPTION
  44 Every menu item has a field that can be used to hold application-specific data
  45 (that is, the menu-driver code leaves it alone).
  46 These functions get and set
  47 that field.
  48 .SH RETURN VALUE
  49 The function \fBitem_userptr\fP returns a pointer (possibly \fBNULL\fP).
  50 It does not set \fBerrno\fP.
  51 .PP
  52 The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).
  53 .
  54 .SH SEE ALSO
  55 \fBcurses\fP(3X), \fBmenu\fP(3X).
  56 .SH NOTES
  57 The header file \fB<menu.h>\fP automatically includes the header file
  58 \fB<curses.h>\fP.
  59 .SH PORTABILITY
  60 These routines emulate the System V menu library.
  61 They were not supported on
  62 Version 7 or BSD versions.
  63 .PP
  64 The user pointer is a void pointer.
  65 We chose not to leave it as a char pointer for SVr4 compatibility.
  66 .SH AUTHORS
  67 Juergen Pfeifer.
  68 Manual pages and adaptation for new curses by Eric S. Raymond.