menu_pattern.3 revision 1.4
$NetBSD: menu_pattern.3,v 1.4 2001/04/29 19:07:07 wiz Exp $
Copyright (c) 1999
Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
This code is donated to The NetBSD Foundation by the author.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the Author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd September 10, 1999 .Dt MENU_PATTERN 3 .Os .Sh NAME .Nm menu_pattern , .Nm set_menu_pattern .Nd get or set menu pattern .Sh LIBRARY .Lb libmenu .Sh SYNOPSIS .Fd #include <menu.h> .Ft char * .Fn menu_pattern "MENU *menu" .Sh DESCRIPTION The .Fn menu_pattern function returns a pointer to the string that is currently in the menu pattern buffer. The menu pattern buffer can be set by calling .Fn set_menu_pattern which will set the pattern buffer to the string passed and then attempt to match that string against the names of the items in the attached items. .Sh RETURN VALUES The functions return one of the following error values:
Copyright (c) 1999
Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
This code is donated to The NetBSD Foundation by the author.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the Author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd September 10, 1999 .Dt MENU_PATTERN 3 .Os .Sh NAME .Nm menu_pattern , .Nm set_menu_pattern .Nd get or set menu pattern .Sh LIBRARY .Lb libmenu .Sh SYNOPSIS .Fd #include <menu.h> .Ft char * .Fn menu_pattern "MENU *menu" .Sh DESCRIPTION The .Fn menu_pattern function returns a pointer to the string that is currently in the menu pattern buffer. The menu pattern buffer can be set by calling .Fn set_menu_pattern which will set the pattern buffer to the string passed and then attempt to match that string against the names of the items in the attached items. .Sh RETURN VALUES The functions return one of the following error values:
p l -tag -width E_BAD_ARGUMENT -compact t Er E_OK The function was successful. t Er E_SYSTEM_ERROR There was a system error during the call. t Er E_BAD_ARGUMENT One or more of the arguments passed to the function was incorrect. t Er E_NO_MATCH The character search failed to find a match. .El .Sh SEE ALSO .Xr curses 3 , .Xr menus 3 .Sh NOTES The header
a <menu.h> automatically includes both
a <curses.h> and
a <eti.h> .