3 ****************************************************************************
4 * Copyright 2018-2021,2022 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: form_requestname.3x,v 1.20 2022/02/12 20:03:40 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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>form_requestname 3x 2022-02-12 ncurses 6.4 Library calls</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">form_requestname 3x 2022-02-12 ncurses 6.4 Library calls</H1>
45 <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> Library calls <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_request_by_name</STRONG>, <STRONG>form_request_name</STRONG> - handle printable form request
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
58 <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*form_request_name(int</STRONG> <EM>request</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>form_request_by_name(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>name</EM><STRONG>);</STRONG>
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 </PRE><H3><a name="h3-form_request_name">form_request_name</a></H3><PRE>
65 The function <STRONG>form_request_name</STRONG> returns the printable name of a form
69 </PRE><H3><a name="h3-form_request_name_by_name">form_request_name_by_name</a></H3><PRE>
70 The function <STRONG>form_request_by_name</STRONG> searches in the name-table for a
71 request with the given name and returns its request code. Otherwise
72 E_NO_MATCH is returned.
75 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76 <STRONG>form_request_name</STRONG> returns <STRONG>NULL</STRONG> on error and sets <STRONG>errno</STRONG> to
77 <STRONG>E_BAD_ARGUMENT</STRONG>.
79 <STRONG>form_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on error. It does not set
80 <STRONG>errno</STRONG>.
83 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
84 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
87 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
88 The header file <STRONG><form.h></STRONG> automatically includes the header file
89 <STRONG><curses.h></STRONG>.
92 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
93 These routines are specific to ncurses. They were not supported on
94 Version 7, BSD or System V implementations. It is recommended that any
95 code depending on them be conditioned using NCURSES_VERSION.
98 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
99 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
104 ncurses 6.4 2022-02-12 <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
108 <li><a href="#h2-NAME">NAME</a></li>
109 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
110 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
112 <li><a href="#h3-form_request_name">form_request_name</a></li>
113 <li><a href="#h3-form_request_name_by_name">form_request_name_by_name</a></li>
116 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
117 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
118 <li><a href="#h2-NOTES">NOTES</a></li>
119 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
120 <li><a href="#h2-AUTHORS">AUTHORS</a></li>