X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_requestname.3x;h=11e5c0fb54f1e4ef25ae5287006675107d5937f4;hb=fae162795e065e5901068152e91f2962b6b247f3;hp=4a4e7eb033e39bf9e596750ef2febfac76c62ae3;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/form_requestname.3x b/man/form_requestname.3x index 4a4e7eb0..11e5c0fb 100644 --- a/man/form_requestname.3x +++ b/man/form_requestname.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 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,38 +28,43 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ +.\" $Id: form_requestname.3x,v 1.16 2020/12/12 16:37:14 tom Exp $ .TH form_requestname 3X "" .SH NAME -\fBform_requestname\fR \- handle printable form request names +\fBform_request_by_name\fP, +\fBform_request_name\fR \- handle printable form request names .SH SYNOPSIS \fB#include \fR +.sp +\fBconst char *form_request_name(int \fP\fIrequest\fP\fB);\fP .br -const char *form_request_name(int request); -.br -int form_request_by_name(const char *name); +\fBint form_request_by_name(const char *\fP\fIname\fP\fB);\fP .br .SH DESCRIPTION +.SS form_request_name The function \fBform_request_name\fR returns the printable name of a form request code. -.br +.SS form_request_name_by_name The function \fBform_request_by_name\fR searches in the name-table for a request -with the given name and returns its request code. Otherwise E_NO_MATCH is returned. +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 +\fBform_request_name\fR returns \fBNULL\fR on error and sets \fBerrno\fP to \fBE_BAD_ARGUMENT\fR. -.br +.PP \fBform_request_by_name\fR returns \fBE_NO_MATCH\fR on error. -It does not set errno. +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. .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.