usr/src/man/man3xcurses/pechochar.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 PECHOCHAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 pechochar, pecho_wchar \- add 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 \fBpechochar\fR(\fBWINDOW *\fR\fIpad\fR, \fBchtype\fR \fIch\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBpecho_wchar\fR(\fBWINDOW *\fR\fIpad\fR, \fBconst chtype *\fR\fIwch\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIpad\fR\fR
  32 .ad
  33 .RS 7n
  34 Is a pointer to the pad in which the character is to be added.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIch\fR\fR
  41 .ad
  42 .RS 7n
  43 Is a pointer to the character to be written to the pad.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIwch\fR\fR
  50 .ad
  51 .RS 7n
  52 Is a pointer to the complex character to be written to the pad.
  53 .RE
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBpechochar()\fR function is equivalent to calling \fBwaddch\fR(3XCURSES)
  59 followed by a call to \fBprefresh\fR(3XCURSES). The \fBpecho_wchar()\fR
  60 function is equivalent to calling \fBwadd_wch\fR(3XCURSES) followed by a call
  61 to \fBprefresh()\fR. \fBprefresh()\fR reuses the last position of the pad on
  62 the screen for its parameters.
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  67 .SH ERRORS
  68 .sp
  69 .LP
  70 None.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Interface Stability     Standard
  85 _
  86 MT-Level        Unsafe
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  93 \fBnewpad\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)