X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_userptr.3x.html;h=78a21f25cddc40c7bab4a9b7753064fb3ce8a461;hp=7d7c5618e01ece08e3e90ca34920fcc7f3b443f6;hb=ce4803687b821efbc5fb2c5a5f06d69cd4dc2656;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/mitem_userptr.3x.html b/doc/html/man/mitem_userptr.3x.html index 7d7c5618..78a21f25 100644 --- a/doc/html/man/mitem_userptr.3x.html +++ b/doc/html/man/mitem_userptr.3x.html @@ -1,82 +1,111 @@ + + +
+ + +- +mitem_userptr(3x) mitem_userptr(3x) --
- mitem_userptr - associate application data with a menu - item --
- #include <menu.h> + +
+ set_item_userptr, item_userptr - associate application + data with a menu item + + +
+ #include <menu.h> int set_item_userptr(ITEM *item, void *userptr); void *item_userptr(const ITEM *item); --
+
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 that field. --
- Except for item_userptr (which returns NULL on error), - each function returns one of the following: - - E_OK The routine succeeded. +
+ The function item_userptr returns a pointer (possibly + NULL). It does not set errno. - E_SYSTEM_ERROR - System error occurred (see errno). + The set_item_userptr always returns E_OK (success). --
- curses(3x), menu(3x). +
+ curses(3x), menu(3x). --
- The header file <menu.h> automatically includes the header - file <curses.h>. +
+ The header file <menu.h> automatically includes the header + file <curses.h>. --
- These routines emulate the System V menu library. They +
+ 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. + 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 +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. - - - - - - - - - - - + mitem_userptr(3x)-