1.\" $NetBSD: menu_item_new.3,v 1.8 2003/04/16 13:35:10 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.In menu.h 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. 52The 53.Fn new_item 54allocates storage for a new item then copies in the item name and 55description for the new item. 56A pointer to the newly created item is returned to the caller. 57.Sh RETURN VALUES 58The 59.Fn new_item 60function returns NULL on failure, the 61.Fn free_item 62returns one of the following error values: 63.Pp 64.Bl -tag -width E_BAD_ARGUMENT -compact 65.It Er E_OK 66The function was successful. 67.It Er E_BAD_ARGUMENT 68One or more of the arguments passed to the function was incorrect. 69.El 70.Sh SEE ALSO 71.Xr curses 3 , 72.Xr menus 3 73.Sh NOTES 74The header 75.Pa \*[Lt]menu.h\*[Gt] 76automatically includes both 77.Pa \*[Lt]curses.h\*[Gt] 78and 79.Pa \*[Lt]eti.h\*[Gt] . 80