source: trunk/ncurses/man/menu_requestname.3x@ 3003

Last change on this file since 3003 was 2621, checked in by bird, 19 years ago

GNU ncurses 5.5

File size: 3.4 KB
Line 
1'\" t
2.\"***************************************************************************
3.\" Copyright (c) 1998 Free Software Foundation, Inc. *
4.\" *
5.\" Permission is hereby granted, free of charge, to any person obtaining a *
6.\" copy of this software and associated documentation files (the *
7.\" "Software"), to deal in the Software without restriction, including *
8.\" without limitation the rights to use, copy, modify, merge, publish, *
9.\" distribute, distribute with modifications, sublicense, and/or sell *
10.\" copies of the Software, and to permit persons to whom the Software is *
11.\" furnished to do so, subject to the following conditions: *
12.\" *
13.\" The above copyright notice and this permission notice shall be included *
14.\" in all copies or substantial portions of the Software. *
15.\" *
16.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23.\" *
24.\" Except as contained in this notice, the name(s) of the above copyright *
25.\" holders shall not be used in advertising or otherwise to promote the *
26.\" sale, use or other dealings in this Software without prior written *
27.\" authorization. *
28.\"***************************************************************************
29.\"
30.\" $Id: menu_requestname.3x,v 1.6 1998/11/29 01:10:40 Rick.Ohnemus Exp $
31.TH menu_requestname 3X ""
32.SH NAME
33\fBmenu_requestname\fR - handle printable menu request names
34.SH SYNOPSIS
35\fB#include <menu.h>\fR
36.br
37const char *menu_request_name(int request);
38.br
39int menu_request_by_name(const char *name);
40.br
41.SH DESCRIPTION
42The function \fBmenu_request_name\fR returns the printable name of a menu
43request code.
44.br
45The function \fBmenu_request_by_name\fR searches in the name-table for a request
46with the given name and returns its request code. Otherwise E_NO_MATCH is returned.
47.SH RETURN VALUE
48\fBmenu_request_name\fR returns \fBNULL\fR on error and sets errno
49to \fBE_BAD_ARGUMENT\fR.
50.br
51\fBmenu_request_by_name\fR returns \fBE_NO_MATCH\fR on error.
52.SH SEE ALSO
53\fBcurses\fR(3X), \fBmenu\fR(3X).
54.SH NOTES
55The header file \fB<menu.h>\fR automatically includes the header file
56\fB<curses.h>\fR.
57.SH PORTABILITY
58These routines are specific to ncurses. They were not supported on
59Version 7, BSD or System V implementations. It is recommended that
60any code depending on them be conditioned using NCURSES_VERSION.
61.SH AUTHORS
62Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
63S. Raymond.
64.\"#
65.\"# The following sets edit modes for GNU EMACS
66.\"# Local Variables:
67.\"# mode:nroff
68.\"# fill-column:79
69.\"# End:
Note: See TracBrowser for help on using the repository browser.