xref: /illumos-gate/usr/src/man/man3xcurses/unctrl.3xcurses (revision 8329232e00f1048795bae53acb230316243aadb5)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, 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]
UNCTRL 3XCURSES "Jun 5, 2002"
NAME
unctrl - generate printable representation of a character
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 <unctrl.h>

char *unctrl(chtype c);
PARAMETERS
c

Is a character.

DESCRIPTION

The unctrl() function generates a character string that is a printable representation of c. If c is a control character,it is converted to the ^X notation. If c contains rendition information, the effect is undefined.

RETURN VALUES

Upon successful completion, the unctrl() function returns the generated string. Otherwise, it returns a null pointer.

ERRORS

No errors are defined.

ATTRIBUTES

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

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

addch(3XCURSES), addstr(3XCURSES), libcurses(3XCURSES), wunctrl(3XCURSES), attributes(5), standards(5)