man/menu_requestname.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,2015 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.33 2024/03/16 15:35:01 tom Exp $
  31 .TH menu_requestname 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .SH NAME
  33 \fBmenu_request_by_name\fP,
  34 \fBmenu_request_name\fP \-
  35 handle printable menu request names
  36 .SH SYNOPSIS
  37 .nf
  38 \fB#include <menu.h>
  39 .PP
  40 \fBconst char *menu_request_name(int \fIrequest\fP);
  41 \fBint menu_request_by_name(const char *\fIname\fP);
  42 .fi
  43 .SH DESCRIPTION
  44 The function \fBmenu_request_name\fP returns the printable name of a menu
  45 request code.
  46 .br
  47 The function \fBmenu_request_by_name\fP 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.
  50 .SH RETURN VALUE
  51 \fBmenu_request_name\fP returns \fBNULL\fP on error
  52 and sets \fBerrno\fP to \fBE_BAD_ARGUMENT\fP.
  53 .br
  54 \fBmenu_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
  55 It does not set \fBerrno\fP.
  56 .SH PORTABILITY
  57 These routines are specific to \fI\%ncurses\fP.
  58 They were not supported on
  59 Version 7, BSD or System V implementations.
  60 It is recommended that
  61 any code depending on them be conditioned using NCURSES_VERSION.
  62 .SH AUTHORS
  63 Juergen Pfeifer.
  64 Manual pages and adaptation for new curses by Eric S. Raymond.
  65 .SH SEE ALSO
  66 \fB\%curses\fP(3X),
  67 \fB\%menu\fP(3X)