]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/mitem_new.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 5.9 - patch 20130518
[ncurses.git] / doc / html / man / mitem_new.3x.html
diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html
index 9918f6cf908626a219cf9e5f55acd69042f4c275..927c3d075e4887010ad3bb0525f68b7e13e0abe5 100644 (file)
--- a/doc/html/man/mitem_new.3x.html
+++ b/doc/html/man/mitem_new.3x.html
@@ -1,30 +1,72 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!-- 
+  * t
+  ****************************************************************************
+  * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+  *                                                                          *
+  * Permission is hereby granted, free of charge, to any person obtaining a  *
+  * copy of this software and associated documentation files (the            *
+  * "Software"), to deal in the Software without restriction, including      *
+  * without limitation the rights to use, copy, modify, merge, publish,      *
+  * distribute, distribute with modifications, sublicense, and/or sell       *
+  * copies of the Software, and to permit persons to whom the Software is    *
+  * furnished to do so, subject to the following conditions:                 *
+  *                                                                          *
+  * The above copyright notice and this permission notice shall be included  *
+  * in all copies or substantial portions of the Software.                   *
+  *                                                                          *
+  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+  *                                                                          *
+  * Except as contained in this notice, the name(s) of the above copyright   *
+  * holders shall not be used in advertising or otherwise to promote the     *
+  * sale, use or other dealings in this Software without prior written       *
+  * authorization.                                                           *
+  ****************************************************************************
+  * @Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
+-->
 <HTML>
 <HTML>
+<HEAD>
+<TITLE>mitem_new 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
 <BODY>
 <BODY>
+<H1>mitem_new 3x</H1>
+<HR>
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>                                             <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
+
+
+
 
 </PRE>
 <H2>NAME</H2><PRE>
 
 </PRE>
 <H2>NAME</H2><PRE>
-       <B>mitem_new</B> - create and destroy menu items
+       <STRONG>mitem_new</STRONG> - create and destroy menu items
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;menu.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
        ITEM *new_item(const char *name, const char *description);
        int free_item(ITEM *item);
 
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
        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
+       The function <STRONG>new_item</STRONG> allocates a new item and initializes
+       it from the <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers.  Please  notice
+       that  the  item  stores  only the pointers to the name and
        description. Those pointers must be valid during the life-
        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
+       time of the item. So you should be very careful with names
+       or descriptions allocated on the stack of some routines.
+       The function <STRONG>free_item</STRONG> 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.
        that  it  is  the  responsibility  of  the  application to
        release the memory for the name or the description of  the
        item.
@@ -32,32 +74,40 @@
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       The function <B>new_item</B> returns <B>NULL</B> on error.
+       The  function  <STRONG>new_item</STRONG>  returns  <STRONG>NULL</STRONG>  on error.  It sets
+       errno according to the function's failure:
 
 
-       The function <B>free_item</B> returns one of the following:
+       <STRONG>E_BAD_ARGUMENT</STRONG>
+            Routine detected an incorrect or  out-of-range  argu-
+            ment.
+
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred, e.g., malloc failure.
 
 
-       <B>E_OK</B> The routine succeeded.
+       The function <STRONG>free_item</STRONG> returns one of the following:
 
 
-       <B>E_SYSTEM_ERROR</B>
-            System error occurred (see <B>errno</B>).
+       <STRONG>E_OK</STRONG> The routine succeeded.
 
 
-       <B>E_BAD_ARGUMENT</B>
+       <STRONG>E_BAD_ARGUMENT</STRONG>
             Routine  detected  an incorrect or out-of-range argu-
             ment.
 
             Routine  detected  an incorrect or out-of-range argu-
             ment.
 
-       <B>E_CONNECTED</B>
+       <STRONG>E_CONNECTED</STRONG>
             Item is connected to a menu.
 
             Item is connected to a menu.
 
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred (see <STRONG>errno</STRONG>).
+
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
 
 </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>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
 
 
 </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>.
+       The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
+       file <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 </PRE>
 
 
 </PRE>
@@ -72,6 +122,8 @@
        curses by Eric S. Raymond.
 
 
        curses by Eric S. Raymond.
 
 
+
+                                                          <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
 </PRE>
 <HR>
 <ADDRESS>
 </PRE>
 <HR>
 <ADDRESS>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/