X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_pattern.3x.html;h=88e6cdb9534de6322da14d7830447590e78ee396;hp=2db0a3afc25f13f9133cf5a760e17c6e2d46aa64;hb=9de646fe8f944e760d453b57e01b866d1d514ad7;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index 2db0a3af..88e6cdb9 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,16 +1,58 @@ + + +
++menu_pattern(3x) menu_pattern(3x) + + +
- menu_pattern - get and set a menu's pattern buffer + menu_pattern - get and set a menu's pattern buffer
- #include <menu.h> + #include <menu.h> int set_menu_pattern(MENU *menu, const char *pattern); char *menu_pattern(const MENU *menu); @@ -18,60 +60,74 @@
Every menu has an associated pattern match buffer. As - input events that are printable ASCII characters come in, - they are appended to this match buffer and tested for a - match, as described in menu_driver(3x). + input events that are printable characters come in, they + are appended to this match buffer and tested for a match, + as described in menu_driver(3x). - The function set_menu_pattern sets the pattern buffer for + The function set_menu_pattern sets the pattern buffer for the given menu and tries to find the first matching item. If it succeeds, that item becomes current; if not, the current item does not change. - The function menu_pattern returns the pattern buffer of - the given menu. + The function menu_pattern returns the pattern buffer of + the given menu.
- The function menu_pattern returns NULL on error. The - function set_menu_pattern may return the following error - codes: + The function menu_pattern returns a pointer, which is NULL + if the menu parameter is NULL. Otherwise, it is a pointer + to a string which is empty if no pattern has been set. It + does not set errno. - E_OK The routine succeeded. + The function set_menu_pattern may return the following + error codes: - E_SYSTEM_ERROR - System error occurred (see errno). + E_OK The routine succeeded. - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argu- ment. - E_NO_MATCH + E_BAD_STATE + Routine was called from an initialization or termina- + tion function. + + E_NOT_CONNECTED + No items are connected to menu. + + E_NO_MATCH Character failed to match. + E_SYSTEM_ERROR + System error occurred (see errno). +
- 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.
- Juergen Pfeifer. Manual pages and adaptation for new + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. + + + menu_pattern(3x)