summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/menu_pattern.3x.html
diff options
context:
space:
mode:
Diffstat (limited to 'ncurses-5.2/doc/html/man/menu_pattern.3x.html')
-rw-r--r--ncurses-5.2/doc/html/man/menu_pattern.3x.html82
1 files changed, 82 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/menu_pattern.3x.html b/ncurses-5.2/doc/html/man/menu_pattern.3x.html
new file mode 100644
index 0000000..2db0a3a
--- /dev/null
+++ b/ncurses-5.2/doc/html/man/menu_pattern.3x.html
@@ -0,0 +1,82 @@
+<HTML>
+<BODY>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>menu_pattern</B> - get and set a menu's pattern buffer
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <B>#include</B> <B>&lt;menu.h&gt;</B>
+ int set_menu_pattern(MENU *menu, const char *pattern);
+ char *menu_pattern(const MENU *menu);
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ 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 <B><A HREF="menu_driver.3x.html">menu_driver(3x)</A></B>.
+
+ The function <B>set_menu_pattern</B> 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 <B>menu_pattern</B> returns the pattern buffer of
+ the given <I>menu</I>.
+
+
+</PRE>
+<H2>RETURN VALUE</H2><PRE>
+ The function <B>menu_pattern</B> returns <B>NULL</B> on error. The
+ function <B>set_menu_pattern</B> may return the following error
+ codes:
+
+ <B>E_OK</B> The routine succeeded.
+
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno</B>).
+
+ <B>E_BAD_ARGUMENT</B>
+ Routine detected an incorrect or out-of-range argu-
+ ment.
+
+ <B>E_NO_MATCH</B>
+ Character failed to match.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
+
+
+</PRE>
+<H2>NOTES</H2><PRE>
+ The header file <B>&lt;menu.h&gt;</B> automatically includes the header
+ file <B>&lt;curses.h&gt;</B>.
+
+
+</PRE>
+<H2>PORTABILITY</H2><PRE>
+ These routines emulate the System V menu library. They
+ were not supported on Version 7 or BSD versions.
+
+
+</PRE>
+<H2>AUTHORS</H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new
+ curses by Eric S. Raymond.
+
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>