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