'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.TH wunctrl 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
wunctrl \- generate printable representation of a wide character
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBwchar_t *\fR\fBwunctrl\fR(\fBcchar_t *\fR\fIwc\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwc\fR\fR
.ad
.RS 6n
.rt  
Is a pointer to the wide character.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBwunctrl()\fR function converts the a wide character string that is a printable representation of the wide character \fIwc\fR. 
.sp
.LP
This function also performs the following processing on the input argument:
.RS +4
.TP
.ie t \(bu
.el o
Control characters are converted to the \fB^\fR\fIX\fR notation
.RE
.RS +4
.TP
.ie t \(bu
.el o
Any rendition information is removed.
.RE
.SH RETURN VALUES
.sp
.LP
Upon successful completion, the \fBwunctrl()\fR function returns the generated string. Otherwise, it returns a null pointer.
.SH ERRORS
.sp
.LP
No errors are defined.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBkeyname\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBunctrl\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)