X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_requestname.3x;h=5b1be8d3d9ecbde3801ca8728971e720242f1a38;hb=2882050bf8b296813e7e026b1c5c45d4a23043e3;hp=a816370a3f960389cc1351f892470bb36173f858;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/form_requestname.3x b/man/form_requestname.3x index a816370a..5b1be8d3 100644 --- a/man/form_requestname.3x +++ b/man/form_requestname.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,36 +27,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_requestname.3x,v 1.12 2020/02/02 23:34:34 tom Exp $ -.TH form_requestname 3X "" +.\" $Id: form_requestname.3x,v 1.30 2023/10/07 21:19:07 tom Exp $ +.TH form_requestname 3X 2023-10-07 "ncurses 6.4" "Library calls" .SH NAME \fBform_request_by_name\fP, -\fBform_request_name\fR \- handle printable form request names +\fBform_request_name\fP \- +handle printable form request names .SH SYNOPSIS -\fB#include \fR -.br -const char *form_request_name(int request); -.br -int form_request_by_name(const char *name); -.br +.nf +\fB#include +.PP +\fBconst char *form_request_name(int \fIrequest\fP); +\fBint form_request_by_name(const char *\fIname\fP); +.fi .SH DESCRIPTION -The function \fBform_request_name\fR returns the printable name of a form +The function \fBform_request_name\fP returns the printable name of a form request code. -.br -The function \fBform_request_by_name\fR searches in the name-table for a request +The function \fBform_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 -\fBform_request_name\fR returns \fBNULL\fR on error and sets errno -to \fBE_BAD_ARGUMENT\fR. -.br -\fBform_request_by_name\fR returns \fBE_NO_MATCH\fR on error. -It does not set errno. -.SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBform_request_name\fP returns \fBNULL\fP on error and sets \fBerrno\fP +to \fBE_BAD_ARGUMENT\fP. +.PP +\fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error. +It does not set \fBerrno\fP. .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 @@ -67,3 +64,6 @@ 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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X)