2 .\"***************************************************************************
3 .\" Copyright 2018,2020 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
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. *
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 *
29 .\"***************************************************************************
31 .\" $Id: form_requestname.3x,v 1.12 2020/02/02 23:34:34 tom Exp $
32 .TH form_requestname 3X ""
34 \fBform_request_by_name\fP,
35 \fBform_request_name\fR \- handle printable form request names
37 \fB#include <form.h>\fR
39 const char *form_request_name(int request);
41 int form_request_by_name(const char *name);
44 The function \fBform_request_name\fR returns the printable name of a form
47 The function \fBform_request_by_name\fR searches in the name-table for a request
48 with the given name and returns its request code.
49 Otherwise E_NO_MATCH is returned.
51 \fBform_request_name\fR returns \fBNULL\fR on error and sets errno
52 to \fBE_BAD_ARGUMENT\fR.
54 \fBform_request_by_name\fR returns \fBE_NO_MATCH\fR on error.
55 It does not set errno.
57 \fBcurses\fR(3X), \fBform\fR(3X).
59 The header file \fB<form.h>\fR automatically includes the header file
62 These routines are specific to ncurses.
63 They were not supported on
64 Version 7, BSD or System V implementations.
65 It is recommended that
66 any code depending on them be conditioned using NCURSES_VERSION.
69 Manual pages and adaptation for new curses by Eric S. Raymond.