xref: /illumos-gate/usr/src/man/man3xcurses/wunctrl.3xcurses (revision 5801b0f01c3c34499a929ed96164a5a68b470945)
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]
WUNCTRL 3XCURSES "Jun 5, 2002"
NAME
wunctrl - generate printable representation of a wide 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 <curses.h>

wchar_t *wunctrl(cchar_t *wc);
PARAMETERS
wc

Is a pointer to the wide character.

DESCRIPTION

The wunctrl() function converts the a wide character string that is a printable representation of the wide character wc.

This function also performs the following processing on the input argument:

Control characters are converted to the ^X notation

Any rendition information is removed.

RETURN VALUES

Upon successful completion, the wunctrl() 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

keyname(3XCURSES), libcurses(3XCURSES), unctrl(3XCURSES), attributes(5), standards(5)