ncurses 5.1
[ncurses.git] / doc / html / man / mitem_userptr.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>mitem_userptr</B>  -  associate  application  data with a menu
9        item
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;menu.h&gt;</B>
15        int set_item_userptr(ITEM *item, void *userptr);
16        void *item_userptr(const ITEM *item);
17
18
19 </PRE>
20 <H2>DESCRIPTION</H2><PRE>
21        Every menu item has a field  that  can  be  used  to  hold
22        application-specific  data  (that is, the menu-driver code
23        leaves it alone).  These functions get and set that field.
24
25
26 </PRE>
27 <H2>RETURN VALUE</H2><PRE>
28        Except  for  <B>item_userptr</B>  (which  returns <B>NULL</B> on error),
29        each function returns one of the following:
30
31        <B>E_OK</B> The routine succeeded.
32
33        <B>E_SYSTEM_ERROR</B>
34             System error occurred (see <B>errno</B>).
35
36
37 </PRE>
38 <H2>SEE ALSO</H2><PRE>
39        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
40
41
42 </PRE>
43 <H2>NOTES</H2><PRE>
44        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
45        file <B>&lt;curses.h&gt;</B>.
46
47
48 </PRE>
49 <H2>PORTABILITY</H2><PRE>
50        These  routines  emulate  the System V menu library.  They
51        were not supported on Version 7 or BSD versions.
52
53        The user pointer should be a void pointer.  We leave it as
54        a char pointer for SVr4 compatibility.
55
56
57 </PRE>
58 <H2>AUTHORS</H2><PRE>
59        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
60        curses by Eric S. Raymond.
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 </PRE>
76 <HR>
77 <ADDRESS>
78 Man(1) output converted with
79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
80 </ADDRESS>
81 </BODY>
82 </HTML>