xref: /freebsd/contrib/ncurses/man/form_requestname.3x (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
t
***************************************************************************
Copyright (c) 1998,2006 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 *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: form_requestname.3x,v 1.7 2006/11/04 17:57:49 tom Exp $
form_requestname 3X ""
NAME
form_requestname - handle printable form request names
SYNOPSIS
#include <form.h>

const char *form_request_name(int request);

int form_request_by_name(const char *name);

DESCRIPTION
The function form_request_name returns the printable name of a form request code.

The function form_request_by_name searches in the name-table for a request with the given name and returns its request code. Otherwise E_NO_MATCH is returned.

RETURN VALUE
form_request_name returns NULL on error and sets errno to E_BAD_ARGUMENT.

form_request_by_name returns E_NO_MATCH on error. It does not set errno.

SEE ALSO
curses(3X), form(3X).
NOTES
The header file <form.h> automatically includes the header file <curses.h>.
PORTABILITY
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.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: