X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_userptr.3x.html;h=67cd03b48ab3f40b0ada760180719bf27c7302cc;hb=3b56f70388c2ae65421ff54b45be77a479e79aea;hp=5eebdb8f64afcd6b615eec64be8a4221637aa925;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/menu_userptr.3x.html b/doc/html/man/menu_userptr.3x.html index 5eebdb8f..67cd03b4 100644 --- a/doc/html/man/menu_userptr.3x.html +++ b/doc/html/man/menu_userptr.3x.html @@ -1,82 +1,113 @@ + + +
+ + +- +menu_userptr(3x) menu_userptr(3x) --
- menu_userptr - associate application data with a menu item --
- #include <menu.h> - int set_menu_userptr(MENU *menu, void *userptr); - void *menu_userptr(const MENU *menu); +
+ set_menu_userptr, menu_userptr - associate application data with a menu + item --
- 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. +
+ #include <menu.h> --
- Except for menu_userptr (which returns NULL on error), - each function returns one of the following: + int set_menu_userptr(MENU *menu, void *userptr); + void *menu_userptr(const MENU *menu); - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - --
- curses(3x), menu(3x). +
+ 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. --
- The header file <menu.h> automatically includes the header - file <curses.h>. - - --
- These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. - - The user pointer should be a void pointer. We leave it as - a char pointer for SVr4 compatibility. - - --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +
+ menu_userptr returns a pointer (which may be NULL). It does not set + errno. + set_menu_userptr returns E_OK (success). +
+ curses(3x), menu(3x). +
+ The header file <menu.h> automatically includes the header file + <curses.h>. +
+ 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. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. + menu_userptr(3x)-