menu_userptr.3x man page

set_menu_userptr, menu_userptr — associate application data with a menu item

Synopsis

#include <menu.h>
int set_menu_userptr(MENU *menu, void *userptr);
void *menu_userptr(const MENU *menu);

Description

Every menu and every menu item has a field that can be used to hold application-specific data (that is, the menu-driver code leaves it alone). These functions get and set the menu user pointer field.

Return Value

menu_userptr returns a pointer (which may be NULL). It does not set errno.

set_menu_userptr returns E_OK (success).

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 user pointer is a void pointer. We chose not to leave it as a char pointer for SVr4 compatibility.

Authors

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

Info