3b9c35825234547eefe33fe9db9de1ff5b53b70d
[ncurses.git] / man / curs_printw.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_printw.3x,v 1.12 2002/07/20 15:01:43 tom Exp $
30 .TH curs_printw 3X ""
31 .SH NAME
32 \fBprintw\fR,
33 \fBwprintw\fR,
34 \fBmvprintw\fR,
35 \fBmvwprintw\fR,
36 \fBvwprintw\fR, \fBvw_printw\fR - print formatted output in \fBcurses\fR windows
37 .SH SYNOPSIS
38 \fB#include <curses.h>\fR
39
40 \fBint printw(char *fmt, ...);\fR
41 .br
42 \fBint wprintw(WINDOW *win, char *fmt, ...);\fR
43 .br
44 \fBint mvprintw(int y, int x, char *fmt, ...);\fR
45 .br
46 \fBint mvwprintw(WINDOW *win, int y, int x, char *fmt, ...);\fR
47 .br
48 \fBint vwprintw(WINDOW *win, char *fmt, va_list varglist);\fR
49 .br
50 \fBint vw_printw(WINDOW *win, char *fmt, va_list varglist);\fR
51 .br
52 .SH DESCRIPTION
53 The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
54 routines are analogous to \fBprintf\fR [see \fBprintf\fR(3S)].  In
55 effect, the string that would be output by \fBprintf\fR is output
56 instead as though \fBwaddstr\fR were used on the given window.
57
58 The \fBvwprintw\fR and \fBwv_printw\fR routines are analogous
59 to \fBvprintf\fR [see \fBprintf\fR(3S)]
60 and perform a \fBwprintw\fR using a variable argument list.
61 The third argument is a \fBva_list\fR, a pointer to a
62 list of arguments, as defined in \fB<stdarg.h>\fR.
63 .SH RETURN VALUE
64 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
65 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
66 completion.
67 .SH PORTABILITY
68 The XSI Curses standard, Issue 4 describes these functions.  The function
69 \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
70 \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
71 The Single Unix Specification, Version 2 states that
72 \fBvw_printw\fR  is preferred to \fBvwprintw\fR since the latter requires
73 including \fB<varargs.h>\fR, which
74 cannot be used in the same file as \fB<stdarg.h>\fR.
75 This implementation uses \fB<stdarg.h>\fR for both, because that header
76 is included in \fB<curses.h\fR>.
77 .SH SEE ALSO
78 \fBcurses\fR(3X), \fBprintf\fR(3S), \fBvprintf(3S)\fR
79 .\"#
80 .\"# The following sets edit modes for GNU EMACS
81 .\"# Local Variables:
82 .\"# mode:nroff
83 .\"# fill-column:79
84 .\"# End: