summaryrefslogtreecommitdiff
path: root/lib/libmenu/mitem_new.3
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>1997-12-14 23:19:42 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>1997-12-14 23:19:42 +0000
commit7f340afc4fe161e24f02ad4cd10947fb416b23df (patch)
tree4ed06254eb130f6607066ef99f21ffdb9899cc4a /lib/libmenu/mitem_new.3
parent85875eb16f014a38c312cea35747914999fc8a9c (diff)
ncurses-4.1-971213
Diffstat (limited to 'lib/libmenu/mitem_new.3')
-rw-r--r--lib/libmenu/mitem_new.355
1 files changed, 55 insertions, 0 deletions
diff --git a/lib/libmenu/mitem_new.3 b/lib/libmenu/mitem_new.3
new file mode 100644
index 00000000000..560e3bdb027
--- /dev/null
+++ b/lib/libmenu/mitem_new.3
@@ -0,0 +1,55 @@
+.\" $OpenBSD: mitem_new.3,v 1.1 1997/12/14 23:19:39 millert Exp $
+'\" t
+.TH mitem_new 3 ""
+.SH NAME
+\fBmitem_new\fR - create and destroy menu items
+.SH SYNOPSIS
+\fB#include <menu.h>\fR
+.br
+ITEM *new_item(const char *name, const char *description);
+.br
+int free_item(ITEM *item);
+.br
+.SH DESCRIPTION
+The function \fBnew_item\fR allocates a new item and initializes it from the
+\fBname\fR and \fBdescription\fR pointers. Please notice that the item stores
+only the pointers to the name and description. Those pointers must be valid
+during the lifetime of the item. So you should be very carefull with names
+or descriptions allocated on the stack of some routines.
+.br
+The function \fBfree_item\fR de-allocates an item. Please notice that it
+is the responsibility of the application to release the memory for the
+name or the description of the item.
+.SH RETURN VALUE
+The function \fBnew_item\fR returns \fBNULL\fR on error.
+
+The function \fBfree_item\fR returns one of the following:
+.TP 5
+\fBE_OK\fR
+The routine succeeded.
+.TP 5
+\fBE_SYSTEM_ERROR\fR
+System error occurred (see \fBerrno\fR).
+.TP 5
+\fBE_BAD_ARGUMENT\fR
+Routine detected an incorrect or out-of-range argument.
+.TP 5
+\fBE_CONNECTED\fR
+Item is connected to a menu.
+.SH SEE ALSO
+\fBcurses\fR(3), \fBmenu\fR(3).
+.SH NOTES
+The header file \fB<menu.h>\fR automatically includes the header file
+\fB<curses.h>\fR.
+.SH PORTABILITY
+These routines emulate the System V menu library. They were not supported on
+Version 7 or BSD versions.
+.SH AUTHORS
+Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
+S. Raymond.
+.\"#
+.\"# The following sets edit modes for GNU EMACS
+.\"# Local Variables:
+.\"# mode:nroff
+.\"# fill-column:79
+.\"# End: