ncurses 6.1 - patch 20180407
[ncurses.git] / man / curs_printw.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2017,2018 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.22 2018/04/07 20:18:55 tom Exp $
30 .TH curs_printw 3X ""
31 .de bP
32 .ie n  .IP \(bu 4
33 .el    .IP \(bu 2
34 ..
35 .na
36 .hy 0
37 .SH NAME
38 \fBprintw\fR,
39 \fBwprintw\fR,
40 \fBmvprintw\fR,
41 \fBmvwprintw\fR,
42 \fBvwprintw\fR, \fBvw_printw\fR \- print formatted output in \fBcurses\fR windows
43 .ad
44 .hy
45 .SH SYNOPSIS
46 \fB#include <curses.h>\fR
47 .sp
48 \fBint printw(const char *fmt, ...);\fR
49 .br
50 \fBint wprintw(WINDOW *win, const char *fmt, ...);\fR
51 .br
52 \fBint mvprintw(int y, int x, const char *fmt, ...);\fR
53 .br
54 \fBint mvwprintw(WINDOW *win, int y, int x, const char *fmt, ...);\fR
55 .br
56 \fBint vw_printw(WINDOW *win, const char *fmt, va_list varglist);\fR
57 .sp
58 /* obsolete */
59 .br
60 \fBint vwprintw(WINDOW *win, const char *fmt, va_list varglist);\fR
61 .SH DESCRIPTION
62 The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
63 routines are analogous to \fBprintf\fR [see \fBprintf\fR(3)].  In
64 effect, the string that would be output by \fBprintf\fR is output
65 instead as though \fBwaddstr\fR were used on the given window.
66 .PP
67 The \fBvwprintw\fR and \fBwv_printw\fR routines are analogous
68 to \fBvprintf\fR [see \fBprintf\fR(3)]
69 and perform a \fBwprintw\fR using a variable argument list.
70 The third argument is a \fBva_list\fR, a pointer to a
71 list of arguments, as defined in \fB<stdarg.h>\fR.
72 .SH RETURN VALUE
73 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
74 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
75 completion.
76 .PP
77 X/Open defines no error conditions.
78 In this implementation,
79 an error may be returned if it cannot allocate enough memory for the
80 buffer used to format the results.
81 It will return an error if the window pointer is null.
82 .PP
83 Functions with a "mv" prefix first perform a cursor movement using
84 \fBwmove\fP, and return an error if the position is outside the window,
85 or if the window pointer is null.
86 .SH PORTABILITY
87 In this implementation, \fBvw_printw\fP and \fBvwprintw\fP are equivalent,
88 to support legacy applications.
89 However, the latter (\fBvwprintw\fP) is obsolete:
90 .bP
91 The XSI Curses standard, Issue 4 described these functions.  The function
92 \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
93 \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
94 .bP
95 The Single Unix Specification, Version 2 states that
96 \fBvw_printw\fR  is preferred to \fBvwprintw\fR since the latter requires
97 including \fB<varargs.h>\fR, which
98 cannot be used in the same file as \fB<stdarg.h>\fR.
99 This implementation uses \fB<stdarg.h>\fR for both,
100 because that header is included in \fB<curses.h\fR>.
101 .bP
102 X/Open Curses, Issue 5 (December 2007) marked \fBvwprintw\fP (along with
103 \fBvwscanw\fP and the termcap interface) as withdrawn.
104 .SH SEE ALSO
105 .na
106 \fBcurses\fR(3X),
107 \fBcurs_addstr\fR(3X),
108 \fBcurs_scanw\fR(3X),
109 \fBcurs_termcap\fP(3X),
110 \fBprintf\fR(3),
111 \fBvprintf\fR(3).