menu_userptr(3x) [freebsd man page]

menu_userptr(3X)														  menu_userptr(3X)

NAME

       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.

																  menu_userptr(3X)

menu_userptr(3CURSES)					     Curses Library Functions					     menu_userptr(3CURSES)

NAME

       menu_userptr, set_menu_userptr - associate application data with menus

SYNOPSIS

       cc [ flag... ] file... -lmenu -lcurses [ library... ]
       #include <menu.h>

       char *menu_userptr(MENU *menu);

       int set_menu_userptr(MENU *menu, char *userptr);

DESCRIPTION

       Every menu has an associated user pointer that can be used to store relevant information. set_menu_userptr() sets the user pointer of menu.
       menu_userptr() returns the user pointer of menu.

RETURN VALUES

       menu_userptr() returns NULL on error.

       set_menu_userptr() returns one of the following:

       E_OK		       The routine returned successfully.

       E_SYSTEM_ERROR	       System error.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), menus(3CURSES), attributes(5)

NOTES

       The header <menu.h> automatically includes the headers  <eti.h> and <curses.h>.

SunOS 5.10							    31 Dec 1996 					     menu_userptr(3CURSES)