NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON

menu_pattern(3X)                                            menu_pattern(3X)

NAME         top

       set_menu_pattern, menu_pattern - set and get a menu's pattern buffer

SYNOPSIS         top

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

DESCRIPTION         top

       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 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         top

       The function menu_pattern returns a pointer, which is NULL if the
       menu parameter is NULL.  Otherwise, it is a pointer to a string which
       is empty if no pattern has been set.  It does not set errno.

       The function set_menu_pattern may return the following error codes:

       E_OK The routine succeeded.

       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.

       E_BAD_STATE
            Routine was called from an initialization or termination
            function.

       E_NOT_CONNECTED
            No items are connected to menu.

       E_NO_MATCH
            Character failed to match.

       E_SYSTEM_ERROR
            System error occurred (see errno).

SEE ALSO         top

       curses(3X), menu(3X).

NOTES         top

       The header file <menu.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       These routines emulate the System V menu library.  They were not
       supported on Version 7 or BSD versions.

AUTHORS         top

       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
       S. Raymond.

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-04-25.  If you
       discover any rendering problems in this HTML version of the page, or
       you believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

                                                            menu_pattern(3X)