'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH menu_item_value 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
menu_item_value, set_item_value, item_value \- set and get menus item values
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
#include
\fBint\fR \fBset_item_value\fR(\fBITEM *\fR\fIitem\fR, \fBint\fR \fIbool\fR);
.fi
.LP
.nf
\fBint\fR \fBitem_value\fR(\fBITEM *\fR\fIitem\fR);
.fi
.SH DESCRIPTION
.sp
.LP
Unlike single-valued menus, multi-valued menus enable the end-user to select one or more items from a menu. \fBset_item_value()\fR sets the selected value of the \fIitem\fR \(em \fBTRUE\fR (selected) or \fBFALSE\fR (not selected). \fBset_item_value()\fR may be used only with multi-valued menus. To make a menu multi-valued, use \fBset_menu_opts\fR or \fBmenu_opts_off()\fR to turn off the option \fBO_ONEVALUE\fR. (See \fBmenu_opts\fR(3CURSES)).
.sp
.LP
\fBitem_value()\fR returns the select value of \fIitem\fR, either \fBTRUE\fR (selected) or \fBFALSE\fR (unselected).
.SH RETURN VALUES
.sp
.LP
\fBset_item_value()\fR returns one of the following:
.sp
.ne 2
.mk
.na
\fBE_OK\fR
.ad
.RS 20n
.rt
The routine returned successfully.
.RE
.sp
.ne 2
.mk
.na
\fBE_SYSTEM_ERROR\fR
.ad
.RS 20n
.rt
System error.
.RE
.sp
.ne 2
.mk
.na
\fBE_REQUEST_DENIED\fR
.ad
.RS 20n
.rt
The menu driver could not process the request.
.RE
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE
.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBmenu_opts\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header \fB\fR automatically includes the headers \fB\fR and \fB\fR\&.