ncurses 6.0 - patch 20151010

[ncurses.git] / man / mitem_new.3x

diff --git a/man/mitem_new.3x b/man/mitem_new.3x
index afba950b13b83bb15a640cb0348142a67b6ec6f5..8e2449e2e2082eec83c31ee8f66e7ef44045319a 100644 (file)
--- a/man/mitem_new.3x
+++ b/man/mitem_new.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,10 +27,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" 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 $

 .TH mitem_new 3X ""
 .SH NAME
 .TH mitem_new 3X ""
 .SH NAME

-\fBmitem_new\fR - create and destroy menu items
+\fBmitem_new\fR \- create and destroy menu items

 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br


@@ -50,20 +50,27 @@ is the responsibility of the application to release the memory for the
 name or the description of the item.
 .SH RETURN VALUE
 The function \fBnew_item\fR returns \fBNULL\fR on error.
 name or the description of the item.
 .SH RETURN VALUE
 The function \fBnew_item\fR returns \fBNULL\fR on error.

-
+It sets errno according to the function's failure:
+.TP 5
+.B E_BAD_ARGUMENT
+Routine detected an incorrect or out-of-range argument.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred, e.g., malloc failure.
+.PP

 The function \fBfree_item\fR returns one of the following:
 .TP 5
 The function \fBfree_item\fR returns one of the following:
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
-.TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT

 Routine detected an incorrect or out-of-range argument.
 .TP 5
 Routine detected an incorrect or out-of-range argument.
 .TP 5

-\fBE_CONNECTED\fR
+.B E_CONNECTED

 Item is connected to a menu.
 Item is connected to a menu.

+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR).

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES


@@ -75,9 +82,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: