doc/html/man/menu_pattern.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>menu_pattern</B> - get and set a menu's pattern buffer
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;menu.h&gt;</B>
  14        int set_menu_pattern(MENU *menu, const char *pattern);
  15        char *menu_pattern(const MENU *menu);
  16
  17
  18 </PRE>
  19 <H2>DESCRIPTION</H2><PRE>
  20        Every  menu  has  an  associated pattern match buffer.  As
  21        input events that are printable ASCII characters come  in,
  22        they  are  appended  to this match buffer and tested for a
  23        match, as described in <B><A HREF="menu_driver.3x.html">menu_driver(3x)</A></B>.
  24
  25        The function <B>set_menu_pattern</B> sets the pattern buffer  for
  26        the  given menu and tries to find the first matching item.
  27        If it succeeds, that item becomes  current;  if  not,  the
  28        current item does not change.
  29
  30        The  function  <B>menu_pattern</B>  returns the pattern buffer of
  31        the given <I>menu</I>.
  32
  33
  34 </PRE>
  35 <H2>RETURN VALUE</H2><PRE>
  36        The function <B>menu_pattern</B>  returns  <B>NULL</B>  on  error.   The
  37        function  <B>set_menu_pattern</B>  may return the following error
  38        codes:
  39
  40        <B>E_OK</B> The routine succeeded.
  41
  42        <B>E_SYSTEM_ERROR</B>
  43             System error occurred (see <B>errno</B>).
  44
  45        <B>E_BAD_ARGUMENT</B>
  46             Routine detected an incorrect or  out-of-range  argu-
  47             ment.
  48
  49        <B>E_NO_MATCH</B>
  50             Character failed to match.
  51
  52
  53 </PRE>
  54 <H2>SEE ALSO</H2><PRE>
  55        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
  56
  57
  58 </PRE>
  59 <H2>NOTES</H2><PRE>
  60        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
  61        file <B>&lt;curses.h&gt;</B>.
  62
  63
  64 </PRE>
  65 <H2>PORTABILITY</H2><PRE>
  66        These routines emulate the System V  menu  library.   They
  67        were not supported on Version 7 or BSD versions.
  68
  69
  70 </PRE>
  71 <H2>AUTHORS</H2><PRE>
  72        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  73        curses by Eric S. Raymond.
  74
  75 </PRE>
  76 <HR>
  77 <ADDRESS>
  78 Man(1) output converted with
  79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  80 </ADDRESS>
  81 </BODY>
  82 </HTML>