| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 1998-2002,2005 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.15 2005/05/15 16:55:16 tom Exp $
|
|---|
| 30 | .TH curs_printw 3X ""
|
|---|
| 31 | .na
|
|---|
| 32 | .hy 0
|
|---|
| 33 | .SH NAME
|
|---|
| 34 | \fBprintw\fR,
|
|---|
| 35 | \fBwprintw\fR,
|
|---|
| 36 | \fBmvprintw\fR,
|
|---|
| 37 | \fBmvwprintw\fR,
|
|---|
| 38 | \fBvwprintw\fR, \fBvw_printw\fR - print formatted output in \fBcurses\fR windows
|
|---|
| 39 | .ad
|
|---|
| 40 | .hy
|
|---|
| 41 | .SH SYNOPSIS
|
|---|
| 42 | \fB#include <curses.h>\fR
|
|---|
| 43 |
|
|---|
| 44 | \fBint printw(const char *fmt, ...);\fR
|
|---|
| 45 | .br
|
|---|
| 46 | \fBint wprintw(WINDOW *win, const char *fmt, ...);\fR
|
|---|
| 47 | .br
|
|---|
| 48 | \fBint mvprintw(int y, int x, const char *fmt, ...);\fR
|
|---|
| 49 | .br
|
|---|
| 50 | \fBint mvwprintw(WINDOW *win, int y, int x, const char *fmt, ...);\fR
|
|---|
| 51 | .br
|
|---|
| 52 | \fBint vwprintw(WINDOW *win, const char *fmt, va_list varglist);\fR
|
|---|
| 53 | .br
|
|---|
| 54 | \fBint vw_printw(WINDOW *win, const char *fmt, va_list varglist);\fR
|
|---|
| 55 | .br
|
|---|
| 56 | .SH DESCRIPTION
|
|---|
| 57 | The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
|
|---|
| 58 | routines are analogous to \fBprintf\fR [see \fBprintf\fR(3S)]. In
|
|---|
| 59 | effect, the string that would be output by \fBprintf\fR is output
|
|---|
| 60 | instead as though \fBwaddstr\fR were used on the given window.
|
|---|
| 61 |
|
|---|
| 62 | The \fBvwprintw\fR and \fBwv_printw\fR routines are analogous
|
|---|
| 63 | to \fBvprintf\fR [see \fBprintf\fR(3S)]
|
|---|
| 64 | and perform a \fBwprintw\fR using a variable argument list.
|
|---|
| 65 | The third argument is a \fBva_list\fR, a pointer to a
|
|---|
| 66 | list of arguments, as defined in \fB<stdarg.h>\fR.
|
|---|
| 67 | .SH RETURN VALUE
|
|---|
| 68 | Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
|
|---|
| 69 | (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
|
|---|
| 70 | completion.
|
|---|
| 71 | .PP
|
|---|
| 72 | X/Open defines no error conditions.
|
|---|
| 73 | In this implementation,
|
|---|
| 74 | an error may be returned if it cannot allocate enough memory for the
|
|---|
| 75 | buffer used to format the results.
|
|---|
| 76 | It will return an error if the window pointer is null.
|
|---|
| 77 | .SH PORTABILITY
|
|---|
| 78 | The XSI Curses standard, Issue 4 describes these functions. The function
|
|---|
| 79 | \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
|
|---|
| 80 | \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
|
|---|
| 81 | The Single Unix Specification, Version 2 states that
|
|---|
| 82 | \fBvw_printw\fR is preferred to \fBvwprintw\fR since the latter requires
|
|---|
| 83 | including \fB<varargs.h>\fR, which
|
|---|
| 84 | cannot be used in the same file as \fB<stdarg.h>\fR.
|
|---|
| 85 | This implementation uses \fB<stdarg.h>\fR for both, because that header
|
|---|
| 86 | is included in \fB<curses.h\fR>.
|
|---|
| 87 | .SH SEE ALSO
|
|---|
| 88 | \fBcurses\fR(3X), \fBprintf\fR(3S), \fBvprintf(3S)\fR
|
|---|
| 89 | .\"#
|
|---|
| 90 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 91 | .\"# Local Variables:
|
|---|
| 92 | .\"# mode:nroff
|
|---|
| 93 | .\"# fill-column:79
|
|---|
| 94 | .\"# End:
|
|---|
