X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fform_requestname.3x;h=5b1be8d3d9ecbde3801ca8728971e720242f1a38;hb=2de8c14bb2c6f8e61cfbbfb1f0f30d1ad64c8d68;hp=11e5c0fb54f1e4ef25ae5287006675107d5937f4;hpb=5925150381bb42a4d8c7116d62c348a7b84309f3;p=ncurses.git diff --git a/man/form_requestname.3x b/man/form_requestname.3x index 11e5c0fb..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,37 +27,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_requestname.3x,v 1.16 2020/12/12 16:37:14 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 -.sp -\fBconst char *form_request_name(int \fP\fIrequest\fP\fB);\fP -.br -\fBint form_request_by_name(const char *\fP\fIname\fP\fB);\fP -.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 -.SS form_request_name -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. -.SS form_request_name_by_name -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 \fBerrno\fP -to \fBE_BAD_ARGUMENT\fR. +\fBform_request_name\fP returns \fBNULL\fP on error and sets \fBerrno\fP +to \fBE_BAD_ARGUMENT\fP. .PP -\fBform_request_by_name\fR returns \fBE_NO_MATCH\fR on error. +\fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error. It does not set \fBerrno\fP. -.SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(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 @@ -68,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)