ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_requestname.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 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: menu_requestname.3x,v 1.10 2015/12/05 23:42:45 tom Exp $
31 .TH menu_requestname 3X ""
32 .SH NAME
33 \fBmenu_request_by_name\fP,
34 \fBmenu_request_name\fR \- handle printable menu request names
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .br
38 const char *menu_request_name(int request);
39 .br
40 int menu_request_by_name(const char *name);
41 .br
42 .SH DESCRIPTION
43 The function \fBmenu_request_name\fR returns the printable name of a menu
44 request code.
45 .br
46 The function \fBmenu_request_by_name\fR searches in the name-table for a request
47 with the given name and returns its request code.
48 Otherwise E_NO_MATCH is returned.
49 .SH RETURN VALUE
50 \fBmenu_request_name\fR returns \fBNULL\fR on error
51 and sets errno to \fBE_BAD_ARGUMENT\fR.
52 .br
53 \fBmenu_request_by_name\fR returns \fBE_NO_MATCH\fR on error.
54 It does not set errno.
55 .SH SEE ALSO
56 \fBcurses\fR(3X), \fBmenu\fR(3X).
57 .SH NOTES
58 The header file \fB<menu.h>\fR automatically includes the header file
59 \fB<curses.h>\fR.
60 .SH PORTABILITY
61 These routines are specific to ncurses.  They were not supported on
62 Version 7, BSD or System V implementations.  It is recommended that
63 any code depending on them be conditioned using NCURSES_VERSION.
64 .SH AUTHORS
65 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
66 S. Raymond.