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