+<!--
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_printw.3x,v 1.28 2020/10/24 09:22:45 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_printw 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">curs_printw 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="curs_printw.3X.html">curs_printw(3X)</A></B> <B><A HREF="curs_printw.3X.html">curs_printw(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B>, <B>mvwprintw</B>, <B>vwprintw</B>, <B>vw_printw</B>
- - print formatted output in <B>curses</B> windows
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B>, <B>mvwprintw</B>, <B>vwprintw</B>, <B>vw_printw</B> - print
+ formatted output in <B>curses</B> windows
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><curses.h></B>
- <B>int</B> <B>printw(char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
- <B>int</B> <B>wprintw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
- <B>int</B> <B>mvprintw(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
- <B>int</B> <B>mvwprintw(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B>
- <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg]</B> ...);
+ <B>int</B> <B>printw(const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
+ <B>int</B> <B>wprintw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
+ <B>int</B> <B>mvprintw(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
+ <B>int</B> <B>mvwprintw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
+ <B>int</B> <B>vw_printw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>va_list</B> <I>varglist</I><B>);</B>
- <B>#include</B> <B><varargs.h></B>
- <B>int</B> <B>vwprintw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>varglist);</B>
- <B>int</B> <B>vw_printw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>varglist);</B>
+ /* obsolete */
+ <B>int</B> <B>vwprintw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>va_list</B> <I>varglist</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B> and <B>mvwprintw</B> routines are
- analogous to <B>printf</B> [see <B><A HREF="printf.3S.html">printf(3S)</A></B>]. In effect, the
- string that would be output by <B>printf</B> is output instead as
- though <B>waddstr</B> were used on the given window.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B> and <B>mvwprintw</B> routines are analogous to
+ <B>printf</B> [see <B>printf(3)</B>]. In effect, the string that would be output by
+ <B>printf</B> is output instead as though <B>waddstr</B> were used on the given win-
+ dow.
- The <B>vwprintw</B> routine is analogous to <B>vprintf</B> [see
- <B><A HREF="printf.3S.html">printf(3S)</A></B>] and performs a <B>wprintw</B> using a variable argu-
- ment list. The third argument is a <B>va_list</B>, a pointer to
- a list of arguments, as defined in <B><varargs.h></B>.
+ The <B>vwprintw</B> and <B>vw_printw</B> routines are analogous to <B>vprintf</B> [see
+ <B>printf(3)</B>] and perform a <B>wprintw</B> using a variable argument list. The
+ third argument is a <B>va_list</B>, a pointer to a list of arguments, as de-
+ fined in <B><stdarg.h></B>.
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Routines that return an integer return <B>ERR</B> upon failure
- and <B>OK</B> (SVr4 only specifies "an integer value other than
- <B>ERR</B>") upon successful completion.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Routines that return an integer return <B>ERR</B> upon failure and <B>OK</B> (SVr4
+ only specifies "an integer value other than <B>ERR</B>") upon successful com-
+ pletion.
+ X/Open defines no error conditions. In this implementation, an error
+ may be returned if it cannot allocate enough memory for the buffer used
+ to format the results. It will return an error if the window pointer
+ is null.
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- The XSI Curses standard, Issue 4 describes these func-
- tions. The function <B>vwprintw</B> is marked TO BE WITHDRAWN,
- and is to be replaced by a function <B>vw_printw</B> using the
- <B><stdarg.h></B> interface.
+ Functions with a "mv" prefix first perform a cursor movement using
+ <B>wmove</B>, and return an error if the position is outside the window, or if
+ the window pointer is null.
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="printf.3S.html">printf(3S)</A></B>, <B>vprintf(3S)</B>
+</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
+ While <B>printw</B> was implemented in 4BSD, it was unused until 4.2BSD (which
+ used it in games). That early version of curses was before the ANSI C
+ standard. It did not use <varargs.h>, though that was available. In
+ 1991 (a couple of years after SVr4 was generally available, and after
+ the C standard was published), other developers updated the library,
+ using <stdarg.h> internally in 4.4BSD curses. Even with this improve-
+ ment, BSD curses did not use function prototypes (or even declare func-
+ tions) in the <curses.h> header until 1992.
+
+ SVr2 documented <B>printw</B>, <B>wprintw</B> tersely as "printf on <I>stdscr</I>" and
+ tersely as "printf on <I>win</I>", respectively.
+ SVr3 added <B>mvprintw</B>, and <B>mvwprintw</B>, with a three-line summary saying
+ that they were analogous to <B>printf(3)</B>, explaining that the string which
+ would be output from <B>printf(3)</B> would instead be output using <B>waddstr</B> on
+ the given window. SVr3 also added <B>vwprintw</B>, saying that the third pa-
+ rameter is a <B>va_list</B>, defined in <varargs.h>, and referring the reader
+ to the manual pages for <I>varargs</I> and <I>vprintf</I> for detailed descriptions.
+ SVr4 added no new variations of <B>printw</B>, but provided for using
+ <varargs.h> or <stdarg.h> to define the <B>va_list</B> type.
+ X/Open Curses added <B>vw_printw</B> to replace <B>vwprintw</B>, stating that its
+ <B>va_list</B> definition requires <stdarg.h>.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ In this implementation, <B>vw_printw</B> and <B>vwprintw</B> are equivalent, to sup-
+ port legacy applications. However, the latter (<B>vwprintw</B>) is obsolete:
+ <B>o</B> The XSI Curses standard, Issue 4 described these functions. The
+ function <B>vwprintw</B> is marked TO BE WITHDRAWN, and is to be replaced
+ by a function <B>vw_printw</B> using the <B><stdarg.h></B> interface.
+ <B>o</B> The Single Unix Specification, Version 2 states that <B>vw_printw</B> is
+ preferred to <B>vwprintw</B> since the latter requires including
+ <B><varargs.h></B>, which cannot be used in the same file as <B><stdarg.h></B>.
+ This implementation uses <B><stdarg.h></B> for both, because that header
+ is included in <B><curses.h</B>>.
+ <B>o</B> X/Open Curses, Issue 5 (December 2007) marked <B>vwprintw</B> (along with
+ <B>vwscanw</B> and the termcap interface) as withdrawn.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_addstr.3X.html">curs_addstr(3X)</A></B>, <B><A HREF="curs_scanw.3X.html">curs_scanw(3X)</A></B>, <B><A HREF="curs_termcap.3X.html">curs_termcap(3X)</A></B>,
+ <B>printf(3)</B>, <B>vprintf(3)</B>.
+ <B><A HREF="curs_printw.3X.html">curs_printw(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff