usr/src/man/man3xcurses/wunctrl.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH WUNCTRL 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 wunctrl \- generate printable representation of a wide character
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBwchar_t *\fR\fBwunctrl\fR(\fBcchar_t *\fR\fIwc\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIwc\fR\fR
  27 .ad
  28 .RS 6n
  29 Is a pointer to the wide character.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBwunctrl()\fR function converts the a wide character string that is a
  36 printable representation of the wide character \fIwc\fR.
  37 .sp
  38 .LP
  39 This function also performs the following processing on the input argument:
  40 .RS +4
  41 .TP
  42 .ie t \(bu
  43 .el o
  44 Control characters are converted to the \fB^\fR\fIX\fR notation
  45 .RE
  46 .RS +4
  47 .TP
  48 .ie t \(bu
  49 .el o
  50 Any rendition information is removed.
  51 .RE
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 Upon successful completion, the \fBwunctrl()\fR function returns the generated
  56 string. Otherwise, it returns a null pointer.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 No errors are defined.
  61 .SH ATTRIBUTES
  62 .sp
  63 .LP
  64 See \fBattributes\fR(5) for descriptions of the following attributes:
  65 .sp
  66
  67 .sp
  68 .TS
  69 box;
  70 c | c
  71 l | l .
  72 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  73 _
  74 Interface Stability     Standard
  75 _
  76 MT-Level        Unsafe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBkeyname\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBunctrl\fR(3XCURSES),
  83 \fBattributes\fR(5), \fBstandards\fR(5)