ncurses 4.1
[ncurses.git] / man / menu_requestname.3x
1 '\" t
2 .TH menu_requestname 3X ""
3 .SH NAME
4 \fBmenu_requestname\fR - handle printable menu request names
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 const char *menu_request_name(int request);
9 .br
10 int menu_request_by_name(const char *name);
11 .br
12 .SH DESCRIPTION
13 The function \fBmenu_request_name\fR returns the printable name of a menu
14 request code.
15 .br
16 The function \fBmenu_request_by_name\fR searches in the name-table for a request
17 with the given name and returns its request code. Otherwise E_NO_MATCH is returned.
18 .SH RETURN VALUE
19 \fBmenu_request_name\fR returns \fBNULL\fR on error and sets errno
20 to \fBE_BAD_ARGUMENT\fR.
21 .br
22 \fBmenu_request_by_name\fR returns \fBE_NO_MATCH\fR on error.
23 .SH SEE ALSO
24 \fBcurses\fR(3X), \fBmenu\fR(3X).
25 .SH NOTES
26 The header file \fB<menu.h>\fR automatically includes the header file
27 \fB<curses.h>\fR.
28 .SH PORTABILITY
29 These routines are specific to ncurses.  They were not supported on
30 Version 7, BSD or System V implementations.  It is recommended that
31 any code depending on them be conditioned using NCURSES_VERSION.
32 .SH AUTHORS
33 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
34 S. Raymond.
35 .\"#
36 .\"# The following sets edit modes for GNU EMACS
37 .\"# Local Variables:
38 .\"# mode:nroff
39 .\"# fill-column:79
40 .\"# End: