menu_items(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON

menu_items(3X)                                            menu_items(3X)

NAME         top

       set_menu_items, menu_items, item_count - make and break
       connections between items and menus

SYNOPSIS         top

       #include <menu.h>

       int set_menu_items(MENU *menu, ITEM **items);
       ITEM **menu_items(const MENU *menu);
       int item_count(const MENU *menu);

DESCRIPTION         top

       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         top

       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:

       E_OK The routine succeeded.

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

       E_NOT_CONNECTED
            No items are connected to the menu.

       E_POSTED
            The menu is already posted.

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

SEE ALSO         top

       curses(3X), menu(3X).

NOTES         top

       The header file <menu.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       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         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       [email protected].  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       [email protected]

                                                          menu_items(3X)