summaryrefslogtreecommitdiff
path: root/lib/libcurses/curs_printw.3
blob: 6fef8bbcab78cb20135ab084a12c854aabdba8a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.\" $OpenBSD: curs_printw.3,v 1.5 1997/12/14 23:15:41 millert Exp $
.TH curs_printw 3 ""
.SH NAME
\fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR,
\fBmvwprintw\fR, \fBvwprintw\fR - print formatted output in
\fBcurses\fR windows
.SH SYNOPSIS
\fB#include <curses.h>\fR

\fBint printw(char *fmt\fR [\fB, arg\fR] \fB...);\fR
.br
\fBint wprintw(WINDOW *win, char *fmt\fR [\fB, arg\fR] \fB...);\fR
.br
\fBint mvprintw(int y, int x, char *fmt\fR [\fB, arg\fR] \fB...);\fR
.br
\fBint mvwprintw(WINDOW *win, int y, int x,
      \fBchar *fmt\fR [\fB, arg]\fR ...);

\fB#include <varargs.h>\fR
.br
\fBint vwprintw(WINDOW *win, char *fmt, varglist);\fR
.br
.SH DESCRIPTION
The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
routines are analogous to \fBprintf\fR [see \fBprintf\fR(3)].  In
effect, the string that would be output by \fBprintf\fR is output
instead as though \fBwaddstr\fR were used on the given window.

The \fBvwprintw\fR routine is analogous to \fBvprintf\fR [see
\fBprintf\fR(3)] and performs a \fBwprintw\fR using a variable
argument list.  The third argument is a \fBva_list\fR, a pointer to a
list of arguments, as defined in \fB<varargs.h>\fR.
.SH RETURN VALUE
Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
(SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
completion.
.SH PORTABILITY
The XSI Curses standard, Issue 4 describes these functions.  The function
\fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
\fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
.SH SEE ALSO
\fBcurses\fR(3), \fBprintf\fR(3), \fBvprintf(3)\fR
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: