ncurses 4.1
[ncurses.git] / man / curs_printw.3x
1 .TH curs_printw 3X ""
2 .SH NAME
3 \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR,
4 \fBmvwprintw\fR, \fBvwprintw\fR - print formatted output in
5 \fBcurses\fR windows
6 .SH SYNOPSIS
7 \fB#include <curses.h>\fR
8
9 \fBint printw(char *fmt\fR [\fB, arg\fR] \fB...);\fR
10 .br
11 \fBint wprintw(WINDOW *win, char *fmt\fR [\fB, arg\fR] \fB...);\fR
12 .br
13 \fBint mvprintw(int y, int x, char *fmt\fR [\fB, arg\fR] \fB...);\fR
14 .br
15 \fBint mvwprintw(WINDOW *win, int y, int x,
16       \fBchar *fmt\fR [\fB, arg]\fR ...);
17
18 \fB#include <varargs.h>\fR
19 .br
20 \fBint vwprintw(WINDOW *win, char *fmt, varglist);\fR
21 .br
22 .SH DESCRIPTION
23 The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
24 routines are analogous to \fBprintf\fR [see \fBprintf\fR(3S)].  In
25 effect, the string that would be output by \fBprintf\fR is output
26 instead as though \fBwaddstr\fR were used on the given window.
27
28 The \fBvwprintw\fR routine is analogous to \fBvprintf\fR [see
29 \fBprintf\fR(3S)] and performs a \fBwprintw\fR using a variable
30 argument list.  The third argument is a \fBva_list\fR, a pointer to a
31 list of arguments, as defined in \fB<varargs.h>\fR.
32 .SH RETURN VALUE
33 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
34 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
35 completion.
36 .SH PORTABILITY
37 The XSI Curses standard, Issue 4 describes these functions.  The function
38 \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
39 \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
40 .SH SEE ALSO
41 \fBcurses\fR(3X), \fBprintf\fR(3S), \fBvprintf(3S)\fR
42 .\"#
43 .\"# The following sets edit modes for GNU EMACS
44 .\"# Local Variables:
45 .\"# mode:nroff
46 .\"# fill-column:79
47 .\"# End: