<!--
****************************************************************************
- * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 2018-2022,2023 Thomas E. Dickey *
* Copyright 1998-2010,2015 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_pattern.3x,v 1.21 2020/10/18 00:41:14 tom Exp @
+ * @Id: menu_pattern.3x,v 1.28 2023/07/01 15:46:10 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>menu_pattern 3X</TITLE>
+<TITLE>menu_pattern 3x 2023-07-01 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
</HEAD>
<BODY>
-<H1 class="no-header">menu_pattern 3X</H1>
+<H1 class="no-header">menu_pattern 3x 2023-07-01 ncurses 6.4 Library calls</H1>
<PRE>
-<B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B> <B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B>
+<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>set_menu_pattern</B>, <B>menu_pattern</B> - set and get a menu's pattern buffer
+ <STRONG>set_menu_pattern</STRONG>, <STRONG>menu_pattern</STRONG> - set and get a menu's pattern buffer
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><menu.h></B>
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
- <B>int</B> <B>set_menu_pattern(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>pattern</I><B>);</B>
- <B>char</B> <B>*menu_pattern(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>set_menu_pattern(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>pattern</EM><STRONG>);</STRONG>
+ <STRONG>char</STRONG> <STRONG>*menu_pattern(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Every menu has an associated pattern match buffer. As input events
that are printable 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>.
+ buffer and tested for a match, as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
- The function <B>set_menu_pattern</B> sets the pattern buffer for the given
+ The function <STRONG>set_menu_pattern</STRONG> 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>.
+ The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of the given <EM>menu</EM>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The function <B>menu_pattern</B> returns a pointer, which is <B>NULL</B> if the <I>menu</I>
- parameter is <B>NULL</B>. Otherwise, it is a pointer to a string which is
- empty if no pattern has been set. It does not set <B>errno</B>.
+ 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 <STRONG>errno</STRONG>.
- The function <B>set_menu_pattern</B> may return the following error codes:
+ The function <STRONG>set_menu_pattern</STRONG> may return the following error codes:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
- <B>E_BAD_STATE</B>
+ <STRONG>E_BAD_STATE</STRONG>
Routine was called from an initialization or termination function.
- <B>E_NOT_CONNECTED</B>
+ <STRONG>E_NOT_CONNECTED</STRONG>
No items are connected to menu.
- <B>E_NO_MATCH</B>
+ <STRONG>E_NO_MATCH</STRONG>
Character failed to match.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno(3)</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <B><menu.h></B> automatically includes the header file
- <B><curses.h></B>.
+ The header file <STRONG><menu.h></STRONG> automatically includes the header file
+ <STRONG><curses.h></STRONG>.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- <B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B>
+ncurses 6.4 2023-07-01 <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff