Content-type: text/html Man page of keyname

keyname

Section: X/Open Curses Library Functions (3XCURSES)
Updated: 5 Jun 2002
Index Return to Main Contents
 

NAME

keyname, key_name - return character string used as key name  

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

char *keyname(int c);

char *key_name(wchar_t wc);  

PARAMETERS

c Is an 8 bit-character or a key code.

wc Is a wide character key name.

 

DESCRIPTION

The keyname() function returns a string pointer to the key name. Make a duplicate copy of the returned string if you plan to modify it.

The key_name() function is similar except that it accepts a wide character key name.

The following table shows the format of the key name based on the input.

InputFormat of Key Name
Visible characterThe same character
Control character^X
Meta-character (keyname() only)M-X
Key value defined in <curses.h> (keyname() only) KEY_name
None of the aboveUNKNOWN KEY

In the preceding table, X can be either a visible character with the high bit cleared or a control character.  

RETURN VALUES

On success, these functions return a pointer to the string used as the key's name. Otherwise, they return a null pointer.  

ERRORS

None.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard
MT-LevelUnsafe

 

SEE ALSO

libcurses(3XCURSES), meta(3XCURSES), attributes(5), standards(5)


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:39:11 GMT, October 02, 2010