ncurses 5.4
[ncurses.git] / doc / html / man / mitem_userptr.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: mitem_userptr.3x,v 1.6 1998/11/29 01:12:47 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>mitem_userptr 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>mitem_userptr 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>                               <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>mitem_userptr</STRONG>  -  associate  application  data with a menu
52        item
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
58        int set_item_userptr(ITEM *item, void *userptr);
59        void *item_userptr(const ITEM *item);
60
61
62 </PRE>
63 <H2>DESCRIPTION</H2><PRE>
64        Every menu item has a field  that  can  be  used  to  hold
65        application-specific  data  (that is, the menu-driver code
66        leaves it alone).  These functions get and set that field.
67
68
69 </PRE>
70 <H2>RETURN VALUE</H2><PRE>
71        Except  for  <STRONG>item_userptr</STRONG>  (which  returns <STRONG>NULL</STRONG> on error),
72        each function returns one of the following:
73
74        <STRONG>E_OK</STRONG> The routine succeeded.
75
76        <STRONG>E_SYSTEM_ERROR</STRONG>
77             System error occurred (see <STRONG>errno</STRONG>).
78
79
80 </PRE>
81 <H2>SEE ALSO</H2><PRE>
82        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
83
84
85 </PRE>
86 <H2>NOTES</H2><PRE>
87        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
88        file <STRONG>&lt;curses.h&gt;</STRONG>.
89
90
91 </PRE>
92 <H2>PORTABILITY</H2><PRE>
93        These  routines  emulate  the System V menu library.  They
94        were not supported on Version 7 or BSD versions.
95
96        The user pointer should be a void pointer.  We leave it as
97        a char pointer for SVr4 compatibility.
98
99
100 </PRE>
101 <H2>AUTHORS</H2><PRE>
102        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
103        curses by Eric S. Raymond.
104
105
106
107                                                 <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
108 </PRE>
109 <HR>
110 <ADDRESS>
111 Man(1) output converted with
112 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
113 </ADDRESS>
114 </BODY>
115 </HTML>