usr/src/man/man3xcurses/vw_printw.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 VW_PRINTW 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 vw_printw \- print formatted output in 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 <stdarg.h>
  18 #include <curses.h>
  19
  20 \fBint\fR \fBvw_printw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR);
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIfmt\fR\fR
  28 .ad
  29 .RS 12n
  30 Is a \fBprintf()\fR format string.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIvarglist\fR\fR
  37 .ad
  38 .RS 12n
  39 Is a pointer to a list of parameters.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIwin\fR\fR
  46 .ad
  47 .RS 12n
  48 Is a pointer to the window in which the string is to be written.
  49 .RE
  50
  51 .SH DESCRIPTION
  52 .sp
  53 .LP
  54 The \fBvw_printw()\fR function achieves the same effect as
  55 \fBwprintw\fR(3XCURSES) using a variable argument list. The third argument is a
  56 \fBva_list\fR, as defined in <\fBstdarg.h\fR>.
  57 .SH RETURN VALUES
  58 .sp
  59 .LP
  60 Upon successful completion, \fBvw_printw()\fR returns \fBOK\fR. Otherwise, it
  61 returns \fBERR\fR.
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 No errors are defined.
  66 .SH USAGE
  67 .sp
  68 .LP
  69 The \fBvw_printw()\fR function is preferred over \fBvwprintw\fR(3XCURSES). The
  70 use of the \fBvwprintw()\fR and \fBvw_printw()\fR in the same file will not
  71 work, due to the requirements to include <\fBvarargs.h\fR> and
  72 <\fBstdarg.h\fR>, which both contain definitions of \fBva_list\fR.
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Standard
  87 _
  88 MT-Level        Unsafe
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBprintf\fR(3C),
  95 \fBattributes\fR(5), \fBstandards\fR(5)