X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_items.3x;h=555498e04034f93280e0d9cc709e3be1b639fffc;hb=2ef2f5486df4a90e2aa9d7544c79b42bca961066;hp=7ec7db5604baf1020a4e44b7bba33ad79b5ac2e2;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/menu_items.3x b/man/menu_items.3x index 7ec7db56..555498e0 100644 --- a/man/menu_items.3x +++ b/man/menu_items.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 1998-2012,2015 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 * @@ -27,65 +28,64 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_items.3x,v 1.5 1998/11/29 01:09:56 Rick.Ohnemus Exp $ +.\" $Id: menu_items.3x,v 1.20 2022/02/12 20:05:11 tom Exp $ .TH menu_items 3X "" .SH NAME -\fBmenu_items\fR - make and break connections between items and menus +\fBset_menu_items\fP, +\fBmenu_items\fP, +\fBitem_count\fP \- make and break connections between items and menus .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_menu_items(MENU *\fImenu\fB, ITEM **\fIitems\fB);\fR .br -int set_menu_items(MENU *menu, ITEM **items); +\fBITEM **menu_items(const MENU *\fImenu\fB);\fR .br -ITEM **menu_items(const MENU *menu); -.br -int item_count(const MENU *menu); +\fBint item_count(const MENU *\fImenu\fB);\fR .br .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. - -The function \fBmenu_items\fR returns the item array of the given menu. - -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 \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error -return value) on error. - -The function \fBset_menu_items\fR returns one of the following codes on error: +The function \fBset_menu_items\fP changes the item pointer array of the given +\fImenu\fP. The array must be terminated by a \fBNULL\fP. +.PP +The function \fBmenu_items\fP returns the item array of the given menu. +.PP +The function \fBitem_count\fP returns the count of items in \fImenu\fP. +.SH RETURN VALUE +The function \fBmenu_items\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. +.PP +The function \fBitem_count\fP returns \fBERR\fP (the general \fBcurses\fP error +return value) if its \fImenu\fP parameter is \fBNULL\fP. +.PP +The function \fBset_menu_items\fP returns one of the following codes on error: .TP 5 -\fBE_OK\fR +.B E_OK 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 -\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 -\fBE_NOT_CONNECTED\fR -No items are connected to the menu. +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). +. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. - -The SVr4 menu library documentation specifies the \fBitem_count\fR error value -as -1 (which is the value of \fBERR\fR). +.PP +The SVr4 menu library documentation specifies the \fBitem_count\fP error value +as \-1 (which is the value of \fBERR\fP). .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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.