X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=inline;f=man%2Fmenu_new.3x;h=3b04f93bb162f24dbfdcbacdfb0a87c9b097b997;hb=fae162795e065e5901068152e91f2962b6b247f3;hp=c53bd9b8cb6554d8385b09f545276eeaddc14205;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/menu_new.3x b/man/menu_new.3x index c53bd9b8..3b04f93b 100644 --- a/man/menu_new.3x +++ b/man/menu_new.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,38 +28,46 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_new.3x,v 1.7 1998/11/29 01:10:13 Rick.Ohnemus Exp $ +.\" $Id: menu_new.3x,v 1.18 2020/10/24 08:57:51 tom Exp $ .TH menu_new 3X "" .SH NAME -\fBmenu_new\fR - create and destroy menus +\fBnew_menu\fP, +\fBfree_menu\fR \- create and destroy menus .SH SYNOPSIS \fB#include \fR +.sp +\fBMENU *new_menu(ITEM **\fP\fIitems\fP\fB);\fP .br -MENU *new_menu(ITEM **items); -.br -int free_menu(MENU *menu); +\fBint free_menu(MENU *\fP\fImenu\fP\fB);\fP .br .SH DESCRIPTION The function \fBnew_menu\fR creates a new menu connected to a specified item pointer array (which must be \fBNULL\fR-terminated). - +.PP The function \fBfree_menu\fR disconnects \fImenu\fR from its item array and frees the storage allocated for the menu. .SH RETURN VALUE The function \fBnew_menu\fR returns \fBNULL\fR on error. - +It sets \fBerrno\fP according to the function's failure: +.TP 5 +.B E_NOT_CONNECTED +No items are connected to the menu. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred, e.g., malloc failure. +.PP The function \fBfree_menu\fR returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_POSTED\fR +.B E_POSTED The menu has already been posted. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). @@ -66,14 +75,9 @@ The menu has already been posted. The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.