ncurses 5.7 - patch 20100731
[ncurses.git] / doc / html / man / menu_requestname.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2006,2010 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.8 2010/07/31 16:08:48 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_requestname 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu_requestname 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>
50 <H2>NAME</H2><PRE>
51        <STRONG>menu_requestname</STRONG> - handle printable menu request names
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        const char *menu_request_name(int request);
58        int menu_request_by_name(const char *name);
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        The  function <STRONG>menu_request_name</STRONG> returns the printable name
64        of a menu request code.
65        The function <STRONG>menu_request_by_name</STRONG> searches in the name-ta-
66        ble  for  a  request  with  the given name and returns its
67        request code.  Otherwise E_NO_MATCH is returned.
68
69
70 </PRE>
71 <H2>RETURN VALUE</H2><PRE>
72        <STRONG>menu_request_name</STRONG> returns <STRONG>NULL</STRONG> on error and sets errno  to
73        <STRONG>E_BAD_ARGUMENT</STRONG>.
74        <STRONG>menu_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on error.  It does
75        not set errno.
76
77
78 </PRE>
79 <H2>SEE ALSO</H2><PRE>
80        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
81
82
83 </PRE>
84 <H2>NOTES</H2><PRE>
85        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
86        file <STRONG>&lt;curses.h&gt;</STRONG>.
87
88
89 </PRE>
90 <H2>PORTABILITY</H2><PRE>
91        These  routines  are  specific  to ncurses.  They were not
92        supported on Version 7, BSD or System  V  implementations.
93        It  is recommended that any code depending on them be con-
94        ditioned using NCURSES_VERSION.
95
96
97 </PRE>
98 <H2>AUTHORS</H2><PRE>
99        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
100        curses by Eric S. Raymond.
101
102
103
104                                                    <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG>
105 </PRE>
106 <HR>
107 <ADDRESS>
108 Man(1) output converted with
109 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
110 </ADDRESS>
111 </BODY>
112 </HTML>