man/man3curses/menu_pattern.3curses

         te
 Copyright 1989 AT&T
 Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 menu_pattern 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
 NAME
menu_pattern, set_menu_pattern - set and get menus pattern match buffer
 SYNOPSIS

cc [ flag... ] file... -lmenu  -lcurses  [ library... ]
#include <menu.h>


char *menu_pattern(MENU *menu);


int set_menu_pattern(MENU *menu, char *pat);


 DESCRIPTION

Every menu has a pattern buffer to match entered data with menu items.
set_menu_pattern() sets the pattern buffer to pat and tries to find
the first item that matches the pattern. If it does, the matching item becomes
the current item. If not, the current item does not change.
menu_pattern() returns the string in the pattern buffer of menu.
 RETURN VALUES

menu_pattern() returns NULL on error. set_menu_pattern()
returns one of the following:

E_OK

The routine returned successfully.


E_SYSTEM_ERROR

System error.


E_BAD_ARGUMENT

An incorrect argument was passed to the routine.


E_NO_MATCH

The character failed to match.


 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe


 SEE ALSO

curses(3CURSES), menus(3CURSES), attributes(5)
 NOTES

The header <menu.h> automatically includes the headers <eti.h> and
<curses.h>.