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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, 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 ECHOCHAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 echochar, wechochar \- add a single-byte character and refresh window
   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 \fBint\fR \fBechochar\fR(\fBconst chtype\fR \fIch\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBwechochar\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype\fR \fIch\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBechochar()\fR function produces the same effect as calling
  31 \fBaddch\fR(3XCURSES) and then \fBrefresh\fR(3XCURSES). The \fBwechochar()\fR
  32 function produces the same effect as calling  \fBwaddch\fR(3XCURSES) and then
  33 \fBwrefresh\fR(3XCURSES).
  34 .SH PARAMETERS
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIch\fR\fR
  39 .ad
  40 .RS 7n
  41 Is a pointer to the character to be written to the window.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIwin\fR\fR
  48 .ad
  49 .RS 7n
  50 Is a pointer to the window in which the character is to be added.
  51 .RE
  52
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 None.
  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 \fBaddch\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBecho_wchar\fR(3XCURSES),
  83 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)