jcs.org
jcs's openbsd hax
openbsd
1'\" t
2.\" $OpenBSD: form_requestname.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
3.\"
4.\"***************************************************************************
5.\" Copyright 2018-2022,2023 Thomas E. Dickey *
6.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
7.\" *
8.\" Permission is hereby granted, free of charge, to any person obtaining a *
9.\" copy of this software and associated documentation files (the *
10.\" "Software"), to deal in the Software without restriction, including *
11.\" without limitation the rights to use, copy, modify, merge, publish, *
12.\" distribute, distribute with modifications, sublicense, and/or sell *
13.\" copies of the Software, and to permit persons to whom the Software is *
14.\" furnished to do so, subject to the following conditions: *
15.\" *
16.\" The above copyright notice and this permission notice shall be included *
17.\" in all copies or substantial portions of the Software. *
18.\" *
19.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
20.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
21.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
22.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
23.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
24.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
25.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26.\" *
27.\" Except as contained in this notice, the name(s) of the above copyright *
28.\" holders shall not be used in advertising or otherwise to promote the *
29.\" sale, use or other dealings in this Software without prior written *
30.\" authorization. *
31.\"***************************************************************************
32.\"
33.\" $Id: form_requestname.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
34.TH form_requestname 3 2023-07-01 "ncurses 6.4" "Library calls"
35.SH NAME
36\fBform_request_by_name\fP,
37\fBform_request_name\fP \- handle printable form request names
38.SH SYNOPSIS
39\fB#include <form.h>\fP
40.sp
41\fBconst char *form_request_name(int \fIrequest\fB);\fR
42.br
43\fBint form_request_by_name(const char *\fIname\fB);\fR
44.SH DESCRIPTION
45.SS form_request_name
46The function \fBform_request_name\fP returns the printable name of a form
47request code.
48.SS form_request_name_by_name
49The function \fBform_request_by_name\fP searches in the name-table for a request
50with the given name and returns its request code.
51Otherwise E_NO_MATCH is returned.
52.SH RETURN VALUE
53\fBform_request_name\fP returns \fBNULL\fP on error and sets \fBerrno\fP
54to \fBE_BAD_ARGUMENT\fP.
55.PP
56\fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
57It does not set \fBerrno\fP.
58.SH SEE ALSO
59\fBcurses\fP(3), \fBform\fP(3).
60.SH NOTES
61The header file \fB<form.h>\fP automatically includes the header file
62\fB<curses.h>\fP.
63.SH PORTABILITY
64These routines are specific to ncurses.
65They were not supported on
66Version 7, BSD or System V implementations.
67It is recommended that
68any code depending on them be conditioned using NCURSES_VERSION.
69.SH AUTHORS
70Juergen Pfeifer.
71Manual pages and adaptation for new curses by Eric S. Raymond.