ncurses-5.2/doc/html/man/mitem_new.3x.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>mitem_new</B> - create and destroy menu items


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;menu.h&gt;</B>
       ITEM *new_item(const char *name, const char *description);
       int free_item(ITEM *item);


</PRE>
<H2>DESCRIPTION</H2><PRE>
       The function <B>new_item</B> allocates a new item and initializes
       it  from  the <B>name</B> and <B>description</B> pointers. Please notice
       that the item stores only the pointers  to  the  name  and
       description. Those pointers must be valid during the life-
       time of the item. So you  should  be  very  carefull  with
       names  or descriptions allocated on the stack of some rou-
       tines.
       The function <B>free_item</B> de-allocates an item. Please notice
       that  it  is  the  responsibility  of  the  application to
       release the memory for the name or the description of  the
       item.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       The function <B>new_item</B> returns <B>NULL</B> on error.

       The function <B>free_item</B> returns one of the following:

       <B>E_OK</B> The routine succeeded.

       <B>E_SYSTEM_ERROR</B>
            System error occurred (see <B>errno</B>).

       <B>E_BAD_ARGUMENT</B>
            Routine  detected  an incorrect or out-of-range argu-
            ment.

       <B>E_CONNECTED</B>
            Item is connected to a menu.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.


</PRE>
<H2>NOTES</H2><PRE>
       The header file <B>&lt;menu.h&gt;</B> automatically includes the header
       file <B>&lt;curses.h&gt;</B>.


</PRE>
<H2>PORTABILITY</H2><PRE>
       These  routines  emulate  the System V menu library.  They
       were not supported on Version 7 or BSD versions.


</PRE>
<H2>AUTHORS</H2><PRE>
       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
       curses by Eric S. Raymond.


</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>