X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_name.3x;h=bf50cfd8f424d0a64ed982dc2ebb975a9f32e1de;hb=42259b594b5dabd37fe2bc294051d2db82e873a2;hp=dcce6990aab265f9104883d2dd2fb9f5de065db2;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c;p=ncurses.git diff --git a/man/mitem_name.3x b/man/mitem_name.3x index dcce6990..bf50cfd8 100644 --- a/man/mitem_name.3x +++ b/man/mitem_name.3x @@ -1,13 +1,44 @@ '\" t +.\"*************************************************************************** +.\" Copyright 2018,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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: mitem_name.3x,v 1.14 2020/10/18 00:37:48 tom Exp $ .TH mitem_name 3X "" .SH NAME -\fBmitem_name\fR - get menu item name and description fields +\fBitem_name\fR, +\fBitem_description\fR \- get menu item name and description fields .SH SYNOPSIS \fB#include \fR +.sp +\fBconst char *item_name(const ITEM *\fP\fIitem\fP\fB);\fP .br -const char *item_name(const ITEM *item); -.br -const char *item_description(const ITEM *item); +\fBconst char *item_description(const ITEM *\fP\fIitem\fP\fB);\fP .br .SH DESCRIPTION The function \fBitem_name\fR returns the name part of the given item. @@ -15,21 +46,16 @@ The function \fBitem_name\fR returns the name part of the given item. The function \fBitem_description\fR returns the description part of the given item. .SH RETURN VALUE -These routines returns \fBNULL\fR on error. +These routines return a pointer (which may be \fBNULL\fR). +They do not set \fBerrno\fP. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES 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 -Version 7 or BSD versions. +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.