pattern(3menu)

pattern3menu

Set and get a menu's pattern buffer

Usage

#include <menu.h>

int set_menu_pattern(MENU *menu, const char *pattern); char *menu_pattern(const MENU *menu);

Overview

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 driver(3MENU).

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

Portability

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

Releases

18 releases since Debian 1.1 (Buzz); the text changed 13 times.

  1. 1.1–1.3
  2. 2.0
  3. 2.1
  4. 2.2
  5. 3.0
  6. 3.1
  7. 4.0
  8. 5.0–6.0
  9. 7–8
  10. 9
  11. 10
  12. 11
  13. 12
  14. 13

Authors

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

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.