ncurses 6.1 - patch 20190518
[ncurses.git] / doc / html / man / menu_requestname.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2015,2018 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_requestname.3x,v 1.11 2018/07/28 21:34:06 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_requestname 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_requestname 3x</H1>
43 <PRE>
44 <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>                                      <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>menu_request_by_name</STRONG>, <STRONG>menu_request_name</STRONG> - handle printable menu request
51        names
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        const char *menu_request_name(int request);
57        int menu_request_by_name(const char *name);
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        The function <STRONG>menu_request_name</STRONG> returns the printable  name  of  a  menu
62        request code.
63        The  function  <STRONG>menu_request_by_name</STRONG>  searches  in  the name-table for a
64        request with the given name and returns its  request  code.   Otherwise
65        E_NO_MATCH is returned.
66
67
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69        <STRONG>menu_request_name</STRONG>  returns  <STRONG>NULL</STRONG> on error and sets errno to <STRONG>E_BAD_ARGU-</STRONG>
70        <STRONG>MENT</STRONG>.
71        <STRONG>menu_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on  error.   It  does  not  set
72        errno.
73
74
75 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
76        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
77
78
79 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
80        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
81        <STRONG>&lt;curses.h&gt;</STRONG>.
82
83
84 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
85        These routines are specific to ncurses.  They  were  not  supported  on
86        Version 7, BSD or System V implementations.  It is recommended that any
87        code depending on them be conditioned using NCURSES_VERSION.
88
89
90 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
91        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
92        Raymond.
93
94
95
96                                                           <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
97 </PRE>
98 <div class="nav">
99 <ul>
100 <li><a href="#h2-NAME">NAME</a></li>
101 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
102 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
103 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
104 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
105 <li><a href="#h2-NOTES">NOTES</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
108 </ul>
109 </div>
110 </BODY>
111 </HTML>