ncurses 5.9 - patch 20130518
[ncurses.git] / doc / html / man / mitem_new.3x.html
index d36dd3dba8c29be6d70fcf62aadd784385a128bc..927c3d075e4887010ad3bb0525f68b7e13e0abe5 100644 (file)
@@ -1,8 +1,8 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <!-- 
   * t
   ****************************************************************************
-  * Copyright (c) 1998,2003 Free Software Foundation, Inc.                   *
+  * 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            *
@@ -28,7 +28,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: mitem_new.3x,v 1.8 2003/10/25 20:08:57 Jared.Yanovich Exp @
+  * @Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
 -->
 <HTML>
 <HEAD>
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
        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
+       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-
        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
+       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 <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error.
+       The  function  <STRONG>new_item</STRONG>  returns  <STRONG>NULL</STRONG>  on error.  It sets
+       errno according to the function's failure:
+
+       <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.
 
        The function <STRONG>free_item</STRONG> returns one of the following:
 
        <STRONG>E_OK</STRONG> The routine succeeded.
 
-       <STRONG>E_SYSTEM_ERROR</STRONG>
-            System error occurred (see <STRONG>errno</STRONG>).
-
        <STRONG>E_BAD_ARGUMENT</STRONG>
-            Routine detected an incorrect or  out-of-range  argu-
+            Routine  detected  an incorrect or out-of-range argu-
             ment.
 
        <STRONG>E_CONNECTED</STRONG>
             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>PORTABILITY</H2><PRE>
-       These routines emulate the System V  menu  library.   They
+       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
+       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
        curses by Eric S. Raymond.