menuformat(3X) menuformat(3X)

NAME
       mmeennuuffoorrmmaatt - set and get menu sizes

SYNOPSIS
       ##iinncclluuddee <>
       int setmenuformat(MENU *menu, int rows, int cols);
       void menuformat(const MENU *menu, int *rows, int *cols);

DESCRIPTION
       The function sseettmmeennuuffoorrmmaatt 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 subwin-
       dow and  the  subwindow  is  too  small  to  display  all  menu  items,
       ppoossttmmeennuu(()) will fail.

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

       The function mmeennuuffoorrmmaatt returns the maximum-size constraints  for  the
       given menu into the storage addressed by rroowwss and ccoollss.

RREETTUURRNN VVAALLUUEE
       These routines returns one of the following:

       EEOOKK The routine succeeded.

       EESSYYSSTTEEMMEERRRROORR
            System error occurred (see eerrrrnnoo).

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

       EEPPOOSSTTEEDD
            The menu is already posted.

SEE ALSO
       ccuurrsseess(3X), mmeennuu(3X).

NNOOTTEESS
       The  header  file  <>  automatically  includes  the  header  file
       <>.

PPOORRTTAABBIILLIITTYY
       These routines emulate the System V menu library.  They were  not  sup-
       ported on Version 7 or BSD versions.

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



                                                               menuformat(3X)