menu_format()

set and get menu sizes 

Curses Function


SYNOPSIS

#include <menu.h>

int set_menu_format(MENU *menu, int rows, int cols);

int menu_format(const MENU *menu, int *rows, int *cols);


DESCRIPTION

The function set_menu_format() sets the maximum display size of the given window. If this size is too small to display all menu items, the menu will be made scrollable.

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 VALUES

These routines returns one of the following:

E_OK 

The routine succeeded.

E_SYSTEM_ERROR 

System error occurred.

E_BAD_ARGUMENT 

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

E_POSTED 

The menu is already posted.


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.


AUTHORS

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


AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition


SEE ALSO

Functions:
curses(), menu()


PTC MKS Toolkit 10.1 Documentation Build 15.