<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998,2002 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_pattern.3x,v 1.7 2002/02/16 22:40:59 tom Exp @
+ * @Id: menu_pattern.3x,v 1.11 2008/06/21 21:58:20 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
</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 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
+ input events that are printable characters come in, they
+ are appended to this match buffer and tested for a match,
+ as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for
the given menu and tries to find the first matching item.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- The function <STRONG>menu_pattern</STRONG> returns <STRONG>NULL</STRONG> on error. The
- function <STRONG>set_menu_pattern</STRONG> may return the following error
- codes:
+ The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG>
+ if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer
+ to a string which is empty if no pattern has been set. It
+ does not set errno.
- <STRONG>E_OK</STRONG> The routine succeeded.
+ The function <STRONG>set_menu_pattern</STRONG> may return the following
+ error codes:
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
ment.
+ <STRONG>E_BAD_STATE</STRONG>
+ Routine was called from an initialization or termina-
+ tion function.
+
+ <STRONG>E_NOT_CONNECTED</STRONG>
+ No items are connected to menu.
+
<STRONG>E_NO_MATCH</STRONG>
Character failed to match.
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
+
</PRE>
<H2>SEE ALSO</H2><PRE>
</PRE>
<H2>PORTABILITY</H2><PRE>
- 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.
</PRE>
<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
+
+
+ <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>