1.\" $NetBSD: menu_pattern.3,v 1.6 2002/02/20 11:47:56 wiz Exp $ 2.\" 3.\" Copyright (c) 1999 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd September 10, 1999 33.Dt MENU_PATTERN 3 34.Os 35.Sh NAME 36.Nm menu_pattern , 37.Nm set_menu_pattern 38.Nd get or set menu pattern 39.Sh LIBRARY 40.Lb libmenu 41.Sh SYNOPSIS 42.Fd #include \*[Lt]menu.h\*[Gt] 43.Ft char * 44.Fn menu_pattern "MENU *menu" 45.Sh DESCRIPTION 46The 47.Fn menu_pattern 48function returns a pointer to the string that is currently in the menu 49pattern buffer. The menu pattern buffer can be set by calling 50.Fn set_menu_pattern 51which will set the pattern buffer to the string passed and then 52attempt to match that string against the names of the items in the 53attached items. 54.Sh RETURN VALUES 55The functions return one of the following error values: 56.Pp 57.Bl -tag -width E_BAD_ARGUMENT -compact 58.It Er E_OK 59The function was successful. 60.It Er E_SYSTEM_ERROR 61There was a system error during the call. 62.It Er E_BAD_ARGUMENT 63One or more of the arguments passed to the function was incorrect. 64.It Er E_NO_MATCH 65The character search failed to find a match. 66.El 67.Sh SEE ALSO 68.Xr curses 3 , 69.Xr menus 3 70.Sh NOTES 71The header 72.Pa \*[Lt]menu.h\*[Gt] 73automatically includes both 74.Pa \*[Lt]curses.h\*[Gt] 75and 76.Pa \*[Lt]eti.h\*[Gt] . 77