mitem_value(3menu)

mitem_value3menu

Set and get menu item values

Part of menu_value(3menu).

Usage

#include <menu.h>
int set_item_value(ITEM *item, bool value);
bool item_value(const ITEM *item);

Overview

If you turn off the menu option O_ONEVALUE (e.g., with set_menu_opts or menu_opts_off; see opts(3MENU)), the menu becomes multi-valued; that is, more than one item may simultaneously be selected.

In a multi_valued menu, you can used set_item_value to select the given menu item (second argument TRUE) or deselect it (second argument FALSE).

Return value

The function set_item_value returns one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno).

E_REQUEST_DENIED

The menu driver could not process the request.

Notes

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

Portability

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

Releases

7 releases since Debian 3.0 (Woody); the text changed 4 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0–6.0
  5. 7–8

Authors

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

From ncurses-doc 5.9+20140913-1+deb8u3 in Debian 8 (Jessie). Parsed by carta from the page's man source.