ncurses 5.7 - patch 20110115

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

diff --git a/man/menu_items.3x b/man/menu_items.3x
index 7ec7db5604baf1020a4e44b7bba33ad79b5ac2e2..a9c578346485b1b68439dc3bb5457b6c841b75d6 100644 (file)
--- a/man/menu_items.3x
+++ b/man/menu_items.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998 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: menu_items.3x,v 1.5 1998/11/29 01:09:56 Rick.Ohnemus Exp $
+.\" $Id: menu_items.3x,v 1.9 2010/12/04 18:40:45 tom Exp $

 .TH menu_items 3X ""
 .SH NAME
 .TH menu_items 3X ""
 .SH NAME

-\fBmenu_items\fR - make and break connections between items and menus
+\fBmenu_items\fR \- make and break connections between items and menus

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


@@ -43,32 +43,34 @@ int item_count(const MENU *menu);
 .SH DESCRIPTION
 The function \fBset_menu_items\fR changes the item pointer array of the given
 \fImenu\fR.  The array must be terminated by a \fBNULL\fR.
 .SH DESCRIPTION
 The function \fBset_menu_items\fR changes the item pointer array of the given
 \fImenu\fR.  The array must be terminated by a \fBNULL\fR.

-
+.PP

 The function \fBmenu_items\fR returns the item array of the given menu.
 The function \fBmenu_items\fR returns the item array of the given menu.

-
+.PP

 The function \fBitem_count\fR returns the count of items in \fImenu\fR.
 .SH RETURN VALUES
 The function \fBitem_count\fR returns the count of items in \fImenu\fR.
 .SH RETURN VALUES

-The function \fBmenu_items\fR returns \fBNULL\fR on error.
-
+The function \fBmenu_items\fR returns a pointer (which may be \fBNULL\fR).
+It does not set errno.
+.PP

 The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error
 The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error

-return value) on error.
-
+return value) if its \fImenu\fP parameter is \fBNULL\fP.
+.PP

 The function \fBset_menu_items\fR returns one of the following codes on error:
 .TP 5
 The function \fBset_menu_items\fR returns one of the following codes on error:
 .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_POSTED\fR
+.B E_NOT_CONNECTED
+No items are connected to the menu.
+.TP 5
+.B E_POSTED

 The menu is already posted.
 .TP 5
 The menu is already posted.
 .TP 5

-\fBE_NOT_CONNECTED\fR
-No items are connected to the menu.
+.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


@@ -77,15 +79,9 @@ The header file \fB<menu.h>\fR automatically includes the header file
 .SH PORTABILITY
 These routines emulate the System V menu library.  They were not supported on
 Version 7 or BSD versions.
 .SH PORTABILITY
 These routines emulate the System V menu library.  They were not supported on
 Version 7 or BSD versions.

-
+.PP

 The SVr4 menu library documentation specifies the \fBitem_count\fR error value
 The SVr4 menu library documentation specifies the \fBitem_count\fR error value

-as -1 (which is the value of \fBERR\fR).
+as \-1 (which is the value of \fBERR\fR).

 .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: