X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_requestname.3x;h=5c46f67d2d980a2deb5e87de1c1de25625a90544;hb=87c2c84cbd2332d6d94b12a1dcaf12ad1a51a938;hp=d1957a2f1cd5f6fc672a4f5848e5c49bcae8a0a9;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/menu_requestname.3x b/man/menu_requestname.3x index d1957a2f..5c46f67d 100644 --- a/man/menu_requestname.3x +++ b/man/menu_requestname.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,39 +28,42 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ +.\" $Id: menu_requestname.3x,v 1.18 2022/02/12 20:02:20 tom Exp $ .TH menu_requestname 3X "" .SH NAME -\fBmenu_requestname\fR \- handle printable menu request names +\fBmenu_request_by_name\fP, +\fBmenu_request_name\fP \- handle printable menu request names .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBconst char *menu_request_name(int \fIrequest\fB);\fR .br -const char *menu_request_name(int request); -.br -int menu_request_by_name(const char *name); +\fBint menu_request_by_name(const char *\fIname\fB);\fR .br .SH DESCRIPTION -The function \fBmenu_request_name\fR returns the printable name of a menu +The function \fBmenu_request_name\fP returns the printable name of a menu request code. .br -The function \fBmenu_request_by_name\fR searches in the name-table for a request +The function \fBmenu_request_by_name\fP searches in the name-table for a request with the given name and returns its request code. Otherwise E_NO_MATCH is returned. .SH RETURN VALUE -\fBmenu_request_name\fR returns \fBNULL\fR on error -and sets errno to \fBE_BAD_ARGUMENT\fR. +\fBmenu_request_name\fP returns \fBNULL\fP on error +and sets \fBerrno\fP to \fBE_BAD_ARGUMENT\fP. .br -\fBmenu_request_by_name\fR returns \fBE_NO_MATCH\fR on error. -It does not set errno. +\fBmenu_request_by_name\fP returns \fBE_NO_MATCH\fP on error. +It does not set \fBerrno\fP. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines are specific to ncurses. They were not supported on -Version 7, BSD or System V implementations. It is recommended that +These routines are specific to ncurses. +They were not supported on +Version 7, BSD or System V implementations. +It is recommended that any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.