1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2010,2017 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: curs_printw.3x,v 1.53 2024/04/20 19:18:18 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>curs_printw 3x 2024-04-20 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">curs_printw 3x 2024-04-20 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG>, <STRONG>mvwprintw</STRONG>, <STRONG>vwprintw</STRONG>, <STRONG>vw_printw</STRONG> - write 51 formatted output to a <EM>curses</EM> window 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 56 57 <STRONG>int</STRONG> <STRONG>printw(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> 58 <STRONG>int</STRONG> <STRONG>wprintw(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> 59 <STRONG>int</STRONG> <STRONG>mvprintw(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> 60 <STRONG>int</STRONG> <STRONG>mvwprintw(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> 61 62 <STRONG>int</STRONG> <STRONG>vw_printw(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>va_list</STRONG> <EM>varglist</EM><STRONG>);</STRONG> 63 64 <EM>/*</EM> <EM>obsolete</EM> <EM>*/</EM> 65 <STRONG>int</STRONG> <STRONG>vwprintw(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>fmt</EM><STRONG>,</STRONG> <STRONG>va_list</STRONG> <EM>varglist</EM><STRONG>);</STRONG> 66 67 68</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 69 <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG>, and <STRONG>mvwprintw</STRONG> are analogous to <STRONG>printf(3)</STRONG>. 70 In effect, the string that would be output by <STRONG>printf(3)</STRONG> is instead 71 output as though <STRONG><A HREF="curs_addstr.3x.html">waddstr(3x)</A></STRONG> were used with <EM>win</EM> (or <STRONG>stdscr</STRONG>) as its 72 first argument. 73 74 <STRONG>vwprintw</STRONG> and <STRONG>vw_printw</STRONG> are analogous to <STRONG>vprintf(3)</STRONG>, and perform a 75 <STRONG>wprintw</STRONG> using a variable argument list. The third argument is a 76 <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, a pointer to a list of arguments, as defined in <EM>stdarg.h</EM>. 77 78 79</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 80 These functions return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon success. 81 82 In <EM>ncurses</EM>, failure occurs if the library cannot allocate enough memory 83 for the buffer into which the output is formatted, or if the window 84 pointer <EM>win</EM> is null. 85 86 Functions prefixed with "mv" first perform cursor movement and fail if 87 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. 88 89 90</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> 91 No wide character counterpart functions are defined by the "wide" 92 <EM>ncurses</EM> configuration nor by any standard. To format and write a wide- 93 character string to a <EM>curses</EM> window, consider using <STRONG>swprintf(3)</STRONG> and 94 <STRONG><A HREF="curs_addwstr.3x.html">waddwstr(3x)</A></STRONG> or similar. 95 96 97</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 98 X/Open Curses, Issue 4 describes these functions. It specifies no 99 error conditions for them. 100 101 <EM>ncurses</EM> defines <STRONG>vw_printw</STRONG> and <STRONG>vwprintw</STRONG> identically to support legacy 102 applications. However, the latter is obsolete. 103 104 <STRONG>o</STRONG> X/Open Curses, Issue 4 Version 2 (1996), marked <STRONG>vwprintw</STRONG> as 105 requiring <EM>varargs.h</EM> and "TO BE WITHDRAWN", and specified <STRONG>vw_printw</STRONG> 106 using the <EM>stdarg.h</EM> interface. 107 108 <STRONG>o</STRONG> X/Open Curses, Issue 5, Draft 2 (December 2007) marked <STRONG>vwprintw</STRONG> 109 (along with <STRONG>vwscanw</STRONG> and the <EM>termcap</EM> interface) as withdrawn. After 110 incorporating review comments, this became X/Open Curses, Issue 7 111 (2009). 112 113 <STRONG>o</STRONG> <EM>ncurses</EM> provides <STRONG>vwprintw</STRONG>, but marks it as deprecated. 114 115 116</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> 117 While <STRONG>printw</STRONG> was implemented in 4BSD (November 1980), it was unused 118 until 4.2BSD (August 1983), which employed it for games. That early 119 version of <EM>curses</EM> preceded the ANSI C standard of 1989. It did not use 120 <EM>varargs.h</EM>, though that had been available since Seventh Edition Unix 121 (1979). In 1991 (a couple of years after SVr4 was generally available, 122 and after the C standard was published), other developers updated the 123 library, using <EM>stdarg.h</EM> internally in 4.4BSD <EM>curses</EM>. Even with this 124 improvement, BSD <EM>curses</EM> did not use function prototypes (nor even 125 declare functions) in <EM>curses.h</EM> until 1992. 126 127 SVr2 (1984) documented <STRONG>printw</STRONG> and <STRONG>wprintw</STRONG> tersely as "printf on <STRONG>stdscr</STRONG>" 128 and "printf on <EM>win</EM>", respectively. 129 130 SVr3 (1987) added <STRONG>mvprintw</STRONG> and <STRONG>mvwprintw</STRONG>, with a three-line summary 131 asserting that they were analogous to <STRONG>printf(3)</STRONG>, explaining that the 132 string that <STRONG>printf(3)</STRONG> would write to the standard output stream would 133 instead be output using <STRONG>waddstr</STRONG> to the given window. SVr3 also 134 implemented <STRONG>vwprintw</STRONG>, describing its third parameter as a <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, 135 defined in <EM>varargs.h</EM>, and referred the reader to the manual pages for 136 <EM>varargs</EM> and <EM>vprintf</EM> for detailed descriptions. 137 138 SVr4 (1989) introduced no new variations of <EM>printw</EM>, but provided for 139 using either <EM>varargs.h</EM> or <EM>stdarg.h</EM> to define the <EM>va</EM><STRONG>_</STRONG><EM>list</EM> type. 140 141 X/Open Curses, Issue 4 (1995), defined <STRONG>vw_printw</STRONG> to replace <STRONG>vwprintw</STRONG>, 142 stating that its <EM>va</EM><STRONG>_</STRONG><EM>list</EM> type is defined in <EM>stdarg.h</EM>. 143 144 145</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 146 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>, <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>, <STRONG>printf(3)</STRONG>, <STRONG>vprintf(3)</STRONG> 147 148 149 150ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> 151</PRE> 152<div class="nav"> 153<ul> 154<li><a href="#h2-NAME">NAME</a></li> 155<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 156<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 157<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 158<li><a href="#h2-NOTES">NOTES</a></li> 159<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 160<li><a href="#h2-HISTORY">HISTORY</a></li> 161<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 162</ul> 163</div> 164</BODY> 165</HTML> 166