1.\" $NetBSD: menu_items.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_ITEMS 3 34.Os 35.Sh NAME 36.Nm item_count , 37.Nm menu_items , 38.Nm set_menu_items 39.Nd attach items to menus or check correspondances 40.Sh LIBRARY 41.Lb libmenu 42.Sh SYNOPSIS 43.Fd #include \*[Lt]menu.h\*[Gt] 44.Ft int 45.Fn item_count "MENU *menu" 46.Ft ITEMS ** 47.Fn menu_items "MENU *menu" 48.Ft int 49.Fn set_menu_items "MENU *menu" "ITEM **items" 50.Sh DESCRIPTION 51The 52.Fn item_count 53.Fa menu 54function returns the number of items currently attached to the menu 55passed. 56The 57.Fn menu_items 58function returns a pointer to an array of item pointers that represent 59the menu items currently attached to the given menu. Apart from using 60.Fn new_menu 61(see 62.Xr menu_new 3 ) 63menu items may be attached to a menu by calling 64.Fn set_menu_items 65any items currently attached to the menu will be detached and the NULL 66terminated array of new items will be attached to the menu. 67.Sh RETURN VALUES 68Any function returning a string pointer will return NULL if an error 69occurs. Functions returning an integer will return one of the 70following: 71.Pp 72.Bl -tag -width E_CONNECTED -compact 73.It Er E_OK 74The function was successful. 75.It Er E_POSTED 76The menu is already posted. 77.It Er E_CONNECTED 78An item was already connected to a menu. 79.El 80.Sh SEE ALSO 81.Xr curses 3 , 82.Xr menus 3 83.Sh NOTES 84The header 85.Pa \*[Lt]menu.h\*[Gt] 86automatically includes both 87.Pa \*[Lt]curses.h\*[Gt] 88and 89.Pa \*[Lt]eti.h\*[Gt] . 90