1.\" $NetBSD: menu_item_new.3,v 1.6 2002/02/20 11:47:23 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_NEW 3 34.Os 35.Sh NAME 36.Nm free_item , 37.Nm new_item 38.Nd create or delete menu item 39.Sh LIBRARY 40.Lb libmenu 41.Sh SYNOPSIS 42.Fd #include \*[Lt]menu.h\*[Gt] 43.Ft int 44.Fn free_item "ITEM *item" 45.Ft ITEM * 46.Fn new_item "char *name" "char *description" 47.Sh DESCRIPTION 48The 49.Fn free_item 50function destroys the item and frees all allocated storage for that 51item. The 52.Fn new_item 53allocates storage for a new item then copies in the item name and 54description for the new item. A pointer to the newly created item is 55returned to the caller. 56.Sh RETURN VALUES 57The 58.Fn new_item 59function returns NULL on failure, the 60.Fn free_item 61returns one of the following error values: 62.Pp 63.Bl -tag -width E_BAD_ARGUMENT -compact 64.It Er E_OK 65The function was successful. 66.It Er E_BAD_ARGUMENT 67One or more of the arguments passed to the function was incorrect. 68.El 69.Sh SEE ALSO 70.Xr curses 3 , 71.Xr menus 3 72.Sh NOTES 73The header 74.Pa \*[Lt]menu.h\*[Gt] 75automatically includes both 76.Pa \*[Lt]curses.h\*[Gt] 77and 78.Pa \*[Lt]eti.h\*[Gt] . 79