keyname(3XCURSES)

Name | Synopsis | Parameters | Description | Return Values | Errors | Attributes | See Also

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.

Input	Format of Key Name
Visible character	The same character
Control character	^X
Meta-character (keyname() only)	M-X
Key value defined in <curses.h> (keyname() only)	KEY_name
None of the above	UNKNOWN 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 TYPE	ATTRIBUTE VALUE
Interface Stability	Standard
MT-Level	Unsafe

See Also

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

SunOS 5.11  Last Revised 5 Jun 2002

Name | Synopsis | Parameters | Description | Return Values | Errors | Attributes | See Also