X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fkeybound.3x;h=61074e436f75ebde303aba341b2fe1324fc56581;hp=79c480cfd3867490e14d83b8c14922e186b76513;hb=refs%2Ftags%2Fv5.4;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/keybound.3x b/man/keybound.3x index 79c480cf..61074e43 100644 --- a/man/keybound.3x +++ b/man/keybound.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999,2002 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2002,2003 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 * @@ -26,9 +26,9 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey 1999 +.\" Author: Thomas E. Dickey 1999 .\" -.\" $Id: keybound.3x,v 1.3 2002/02/16 22:30:36 tom Exp $ +.\" $Id: keybound.3x,v 1.5 2003/10/25 20:33:16 tom Exp $ .TH keyok 3X "" .SH NAME \fBkeybound\fP \- return definition of keycode @@ -41,9 +41,12 @@ This is an extension to the curses library. It permits an application to determine the string which is defined in the terminfo for specific keycodes. .SH RETURN VALUE -The keycode must be greater than zero, else NULL is returned. +The \fIkeycode\fP parameter must be greater than zero, else NULL is returned. If it does not correspond to a defined key, then NULL is returned. -Otherwise, the function returns a string, which must be freed by the caller. +The \fIcount\fP parameter is used to allow the application to iterate +through multiple definitions, counting from zero. +When successful, +the function returns a string which must be freed by the caller. .SH PORTABILITY These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that