X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_pattern.3x.html;h=997be0c0aa1bc2394d0bd8338ba276119e0370f5;hp=84a9de8bbaec15c41cce227cca88d567d23a55a3;hb=a0b91dc27f0c411e343161b0a4b5459d15a43f85;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index 84a9de8b..997be0c0 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,7 +1,6 @@ - +
+ +- -menu_pattern(3x) menu_pattern(3x) +menu_pattern(3x) menu_pattern(3x)-
+NAME
menu_pattern - get and set a menu's pattern buffer-SYNOPSIS
+SYNOPSIS
#include <menu.h> int set_menu_pattern(MENU *menu, const char *pattern); char *menu_pattern(const MENU *menu);-DESCRIPTION
+DESCRIPTION
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 given menu and tries to find the first matching item. @@ -74,54 +74,72 @@-RETURN VALUE
- The function menu_pattern returns NULL on error. The - function set_menu_pattern may return the following error - codes: +RETURN VALUE
+ 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 Routine detected an incorrect or out-of-range argu- ment. + 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). +-SEE ALSO
+SEE ALSO
curses(3x), menu(3x).-NOTES
+NOTES
The header file <menu.h> automatically includes the header file <curses.h>.-PORTABILITY
- These routines emulate the System V menu library. They +PORTABILITY
+ These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.-AUTHORS
- Juergen Pfeifer. Manual pages and adaptation for new +AUTHORS
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. - menu_pattern(3x) + menu_pattern(3x)-
- -Man(1) output converted with -man2html - +