86 lines
2.8 KiB
Groff
86 lines
2.8 KiB
Groff
|
.\" $NetBSD: menu_new.3,v 1.10 2012/06/30 09:25:55 jdf Exp $
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 1999
|
||
|
|
.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
|
||
|
|
.\"
|
||
|
|
.\" This code is donated to The NetBSD Foundation by the author.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\" 3. The name of the Author may not be used to endorse or promote
|
||
|
|
.\" products derived from this software without specific prior written
|
||
|
|
.\" permission.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||
|
|
.\" SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd September 10, 1999
|
||
|
|
.Dt MENU_NEW 3
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm free_menu ,
|
||
|
|
.Nm new_menu
|
||
|
|
.Nd create or delete a menu
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb libmenu
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In menu.h
|
||
|
|
.Ft int
|
||
|
|
.Fn free_menu "MENU *menu"
|
||
|
|
.Ft MENU *
|
||
|
|
.Fn new_menu "ITEM **items"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn free_menu
|
||
|
|
.Fa menu
|
||
|
|
function destroys the given menu and frees all allocated storage
|
||
|
|
associated with the menu.
|
||
|
|
All items associated with the menu are
|
||
|
|
detached from the menu before it is destroyed.
|
||
|
|
The
|
||
|
|
.Fn new_menu
|
||
|
|
function allocates storage for a new menu and initializes all the
|
||
|
|
values to the defined defaults.
|
||
|
|
If the items pointer passed is not a NULL then the given NULL terminated
|
||
|
|
array of items is attached to the new menu.
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
The
|
||
|
|
.Fn new_menu
|
||
|
|
function returns NULL on error, while the
|
||
|
|
.Fn free_menu
|
||
|
|
function returns one of the following error values:
|
||
|
|
.Pp
|
||
|
|
.Bl -tag -width E_BAD_ARGUMENT -compact
|
||
|
|
.It Er E_OK
|
||
|
|
The function was successful.
|
||
|
|
.It Er E_BAD_ARGUMENT
|
||
|
|
One or more of the arguments passed to the function was incorrect.
|
||
|
|
.It Er E_POSTED
|
||
|
|
The menu is already posted.
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr curses 3 ,
|
||
|
|
.Xr menus 3
|
||
|
|
.Sh NOTES
|
||
|
|
The header
|
||
|
|
.Pa \*[Lt]menu.h\*[Gt]
|
||
|
|
automatically includes both
|
||
|
|
.Pa \*[Lt]curses.h\*[Gt]
|
||
|
|
and
|
||
|
|
.Pa \*[Lt]eti.h\*[Gt] .
|