ncurses 5.3
[ncurses.git] / doc / html / man / menu_pattern.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_pattern.3x,v 1.7 2002/02/16 22:40:59 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>menu_pattern 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>menu_pattern 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>menu_pattern</STRONG> - get and set a menu's pattern buffer
47
48
49 </PRE>
50 <H2>SYNOPSIS</H2><PRE>
51        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
52        int set_menu_pattern(MENU *menu, const char *pattern);
53        char *menu_pattern(const MENU *menu);
54
55
56 </PRE>
57 <H2>DESCRIPTION</H2><PRE>
58        Every  menu  has  an  associated pattern match buffer.  As
59        input events that are printable ASCII characters come  in,
60        they  are  appended  to this match buffer and tested for a
61        match, as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
62
63        The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer  for
64        the  given menu and tries to find the first matching item.
65        If it succeeds, that item becomes  current;  if  not,  the
66        current item does not change.
67
68        The  function  <STRONG>menu_pattern</STRONG>  returns the pattern buffer of
69        the given <EM>menu</EM>.
70
71
72 </PRE>
73 <H2>RETURN VALUE</H2><PRE>
74        The function <STRONG>menu_pattern</STRONG>  returns  <STRONG>NULL</STRONG>  on  error.   The
75        function  <STRONG>set_menu_pattern</STRONG>  may return the following error
76        codes:
77
78        <STRONG>E_OK</STRONG> The routine succeeded.
79
80        <STRONG>E_SYSTEM_ERROR</STRONG>
81             System error occurred (see <STRONG>errno</STRONG>).
82
83        <STRONG>E_BAD_ARGUMENT</STRONG>
84             Routine detected an incorrect or  out-of-range  argu-
85             ment.
86
87        <STRONG>E_NO_MATCH</STRONG>
88             Character failed to match.
89
90
91 </PRE>
92 <H2>SEE ALSO</H2><PRE>
93        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
94
95
96 </PRE>
97 <H2>NOTES</H2><PRE>
98        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
99        file <STRONG>&lt;curses.h&gt;</STRONG>.
100
101
102 </PRE>
103 <H2>PORTABILITY</H2><PRE>
104        These routines emulate the System V  menu  library.   They
105        were not supported on Version 7 or BSD versions.
106
107
108 </PRE>
109 <H2>AUTHORS</H2><PRE>
110        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
111        curses by Eric S. Raymond.
112
113 </PRE>
114 <HR>
115 <ADDRESS>
116 Man(1) output converted with
117 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
118 </ADDRESS>
119 </BODY>
120 </HTML>