| 1 | '\" t
|
|---|
| 2 | .\"***************************************************************************
|
|---|
| 3 | .\" Copyright (c) 1998,2003 Free Software Foundation, Inc. *
|
|---|
| 4 | .\" *
|
|---|
| 5 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 6 | .\" copy of this software and associated documentation files (the *
|
|---|
| 7 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 8 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 9 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 10 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 11 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 12 | .\" *
|
|---|
| 13 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 14 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 15 | .\" *
|
|---|
| 16 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 17 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 18 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 19 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 20 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 21 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 22 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 23 | .\" *
|
|---|
| 24 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 25 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 26 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 27 | .\" authorization. *
|
|---|
| 28 | .\"***************************************************************************
|
|---|
| 29 | .\"
|
|---|
| 30 | .\" $Id: mitem_new.3x,v 1.8 2003/10/25 20:08:57 Jared.Yanovich Exp $
|
|---|
| 31 | .TH mitem_new 3X ""
|
|---|
| 32 | .SH NAME
|
|---|
| 33 | \fBmitem_new\fR - create and destroy menu items
|
|---|
| 34 | .SH SYNOPSIS
|
|---|
| 35 | \fB#include <menu.h>\fR
|
|---|
| 36 | .br
|
|---|
| 37 | ITEM *new_item(const char *name, const char *description);
|
|---|
| 38 | .br
|
|---|
| 39 | int free_item(ITEM *item);
|
|---|
| 40 | .br
|
|---|
| 41 | .SH DESCRIPTION
|
|---|
| 42 | The function \fBnew_item\fR allocates a new item and initializes it from the
|
|---|
| 43 | \fBname\fR and \fBdescription\fR pointers. Please notice that the item stores
|
|---|
| 44 | only the pointers to the name and description. Those pointers must be valid
|
|---|
| 45 | during the lifetime of the item. So you should be very careful with names
|
|---|
| 46 | or descriptions allocated on the stack of some routines.
|
|---|
| 47 | .br
|
|---|
| 48 | The function \fBfree_item\fR de-allocates an item. Please notice that it
|
|---|
| 49 | is the responsibility of the application to release the memory for the
|
|---|
| 50 | name or the description of the item.
|
|---|
| 51 | .SH RETURN VALUE
|
|---|
| 52 | The function \fBnew_item\fR returns \fBNULL\fR on error.
|
|---|
| 53 |
|
|---|
| 54 | The function \fBfree_item\fR returns one of the following:
|
|---|
| 55 | .TP 5
|
|---|
| 56 | \fBE_OK\fR
|
|---|
| 57 | The routine succeeded.
|
|---|
| 58 | .TP 5
|
|---|
| 59 | \fBE_SYSTEM_ERROR\fR
|
|---|
| 60 | System error occurred (see \fBerrno\fR).
|
|---|
| 61 | .TP 5
|
|---|
| 62 | \fBE_BAD_ARGUMENT\fR
|
|---|
| 63 | Routine detected an incorrect or out-of-range argument.
|
|---|
| 64 | .TP 5
|
|---|
| 65 | \fBE_CONNECTED\fR
|
|---|
| 66 | Item is connected to a menu.
|
|---|
| 67 | .SH SEE ALSO
|
|---|
| 68 | \fBcurses\fR(3X), \fBmenu\fR(3X).
|
|---|
| 69 | .SH NOTES
|
|---|
| 70 | The header file \fB<menu.h>\fR automatically includes the header file
|
|---|
| 71 | \fB<curses.h>\fR.
|
|---|
| 72 | .SH PORTABILITY
|
|---|
| 73 | These routines emulate the System V menu library. They were not supported on
|
|---|
| 74 | Version 7 or BSD versions.
|
|---|
| 75 | .SH AUTHORS
|
|---|
| 76 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
|
|---|
| 77 | S. Raymond.
|
|---|
| 78 | .\"#
|
|---|
| 79 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 80 | .\"# Local Variables:
|
|---|
| 81 | .\"# mode:nroff
|
|---|
| 82 | .\"# fill-column:79
|
|---|
| 83 | .\"# End:
|
|---|
