mirror of
https://github.com/Aigor44/ncursesw-morphos.git
synced 2024-12-21 07:39:06 +08:00
55 lines
1.6 KiB
Plaintext
55 lines
1.6 KiB
Plaintext
'\" t
|
|
.TH mitem_new 3X ""
|
|
.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(3X), \fBmenu\fR(3X).
|
|
.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:
|