menu_format(3X)                                              menu_format(3X)

NAME         top

       set_menu_format, menu_format - set and get menu sizes

SYNOPSIS         top

       #include <menu.h>
       int set_menu_format(MENU *menu, int rows, int cols);
       void menu_format(const MENU *menu, int *rows, int *cols);

DESCRIPTION         top

       The function set_menu_format sets the maximum display size of the
       given menu.  If this size is too small to display all menu items, the
       menu will be made scrollable. If this size is larger than the menus
       subwindow and the subwindow is too small to display all menu items,
       post_menu will fail.

       The default format is 16 rows, 1 column.  Calling set_menu_format
       with a null menu pointer will change this default.  A zero row or
       column argument to set_menu_format is interpreted as a request not to
       change the current value.

       The function menu_format returns the maximum-size constraints for the
       given menu into the storage addressed by rows and cols.

RETURN VALUE         top

       These routines returns one of the following:

       E_OK The routine succeeded.

            System error occurred (see errno).

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

            The menu is already posted.

            No items are connected to the menu.

SEE ALSO         top

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

NOTES         top

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

PORTABILITY         top

       These routines emulate the System V menu library.  They were not
       supported on Version 7 or BSD versions.

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 
       ⟨⟩.  If you have a
       bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://⟩ on 2017-03-13.  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