xref: /illumos-gate/usr/src/man/man3xcurses/keyname.3xcurses (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
KEYNAME 3XCURSES "Jun 5, 2002"
NAME
keyname, key_name - return character string used as key name
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

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