xref: /freebsd/contrib/ncurses/man/menu_items.3x (revision eb1e8a82963684bac34c992a409a5f6ef6ed08c3)
t
***************************************************************************
Copyright 2018-2019,2020 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 *
"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: menu_items.3x,v 1.14 2020/02/02 23:34:34 tom Exp $
menu_items 3X ""
NAME
set_menu_items, menu_items, item_count - make and break connections between items and menus
SYNOPSIS
#include <menu.h>

int set_menu_items(MENU *menu, ITEM **items);

ITEM **menu_items(const MENU *menu);

int item_count(const MENU *menu);

DESCRIPTION
The function set_menu_items changes the item pointer array of the given menu. The array must be terminated by a NULL.

The function menu_items returns the item array of the given menu.

The function item_count returns the count of items in menu.

RETURN VALUE
The function menu_items returns a pointer (which may be NULL). It does not set errno.

The function item_count returns ERR (the general curses error return value) if its menu parameter is NULL.

The function set_menu_items returns one of the following codes on error:

5 E_OK The routine succeeded.

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

5 E_NOT_CONNECTED No items are connected to the menu.

5 E_POSTED The menu is already posted.

5 E_SYSTEM_ERROR System error occurred (see errno(3)). .

SEE ALSO
curses(3X), menu(3X).
NOTES
The header file <menu.h> automatically includes the header file <curses.h>.
PORTABILITY
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 item_count error value as -1 (which is the value of ERR).

AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.