:man| Alphabetical   Categories   About us 
 
menu_pattern (3X) | C library functions | Unix Manual Pages | :man

NAME

menu_pattern - get and set a menu’s pattern buffer

CONTENTS

Synopsis
Description
Return Value
See Also
Notes
Portability
Authors

SYNOPSIS

#include <menu.h>
int set_menu_pattern(MENU *menu, const char *pattern);
char *menu_pattern(const MENU *menu);

DESCRIPTION

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 menu_driver(3X).

The function set_menu_pattern 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 menu_pattern returns the pattern buffer of the given menu.

RETURN VALUE

The function menu_pattern returns NULL on error. The function set_menu_pattern may return the following error codes: -->
E_OK The routine succeeded.
E_SYSTEM_ERROR
System error occurred (see errno).
E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
E_NO_MATCH
Character failed to match.

SEE ALSO

curses(3), menu(3).

NOTES

PORTABILITY

AUTHORS

 
Created by Blin Media, 2008-2013