usr/src/man/man3xcurses/unctrl.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 UNCTRL 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 unctrl \- generate printable representation of a 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 <unctrl.h>
  18
  19 \fBchar *\fR\fBunctrl\fR(\fBchtype\fR \fIc\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIc\fR\fR
  27 .ad
  28 .RS 5n
  29 Is a character.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBunctrl()\fR function generates a character string that is a printable
  36 representation of \fIc\fR. If \fIc\fR is a control character,it is converted to
  37 the  \fB^\fR\fIX\fR notation. If \fIc\fR contains rendition information, the
  38 effect is undefined.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 Upon successful completion, the \fBunctrl()\fR function returns the generated
  43 string. Otherwise, it returns a null pointer.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 No errors are defined.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        Unsafe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBaddch\fR(3XCURSES), \fBaddstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  70 \fBwunctrl\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)