1.\" $NetBSD: menu_item_opts.3,v 1.6 2002/02/20 11:47:56 wiz Exp $ 2.\" 3.\" Copyright (c) 1999 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd September 10, 1999 33.Dt MENU_ITEM_OPTS 3 34.Os 35.Sh NAME 36.Nm item_opts , 37.Nm item_opts_off , 38.Nm item_opts_on 39.Nd get or modify options for an item 40.Sh LIBRARY 41.Lb libmenu 42.Sh SYNOPSIS 43.Fd #include \*[Lt]menu.h\*[Gt] 44.Ft OPTIONS 45.Fn item_opts "ITEM *item" 46.Ft int 47.Fn item_opts_off "ITEM *item" "OPTIONS opts" 48.Ft int 49.Fn item_opts_on "ITEM *item" "OPTIONS opts" 50.Sh DESCRIPTION 51The 52.Fn item_opts 53function returns the options currently set for the given item. The 54.Fn item_opts_off 55function turns off the options passed in 56.Fa opts 57for the item passed. The 58.Fn item_opts_on 59function turns on the options passed in 60.Fa opts 61for the item given. 62.Sh RETURN VALUES 63The functions return one of the following error values: 64.Pp 65.Bl -tag -width E_SYSTEM_ERROR -compact 66.It Er E_OK 67The function was successful. 68.It Er E_SYSTEM_ERROR 69There was a system error during the call. 70.El 71.Sh SEE ALSO 72.Xr curses 3 , 73.Xr menus 3 74.Sh NOTES 75The header 76.Pa \*[Lt]menu.h\*[Gt] 77automatically includes both 78.Pa \*[Lt]curses.h\*[Gt] 79and 80.Pa \*[Lt]eti.h\*[Gt] . 81