curs_printw.3x.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. ****************************************************************************
  4. * Copyright (c) 1998-2005,2006 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.17 2006/12/24 16:05:17 tom Exp @
  31. -->
  32. <HTML>
  33. <HEAD>
  34. <TITLE>curs_printw 3x</TITLE>
  35. <link rev=made href="mailto:bug-ncurses@gnu.org">
  36. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37. </HEAD>
  38. <BODY>
  39. <H1>curs_printw 3x</H1>
  40. <HR>
  41. <PRE>
  42. <!-- Manpage converted by man2html 3.0.1 -->
  43. <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
  44. </PRE>
  45. <H2>NAME</H2><PRE>
  46. <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG>, <STRONG>mvwprintw</STRONG>, <STRONG>vwprintw</STRONG>, <STRONG>vw_printw</STRONG>
  47. - print formatted output in <STRONG>curses</STRONG> windows
  48. </PRE>
  49. <H2>SYNOPSIS</H2><PRE>
  50. <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  51. <STRONG>int</STRONG> <STRONG>printw(const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  52. <STRONG>int</STRONG> <STRONG>wprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  53. <STRONG>int</STRONG> <STRONG>mvprintw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  54. <STRONG>int</STRONG> <STRONG>mvwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG>
  55. <STRONG>...);</STRONG>
  56. <STRONG>int</STRONG> <STRONG>vwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>var-</STRONG>
  57. <STRONG>glist);</STRONG>
  58. <STRONG>int</STRONG> <STRONG>vw_printw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>var-</STRONG>
  59. <STRONG>glist);</STRONG>
  60. </PRE>
  61. <H2>DESCRIPTION</H2><PRE>
  62. The <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG> and <STRONG>mvwprintw</STRONG> routines are
  63. analogous to <STRONG>printf</STRONG> [see <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>]. In effect, the
  64. string that would be output by <STRONG>printf</STRONG> is output instead as
  65. though <STRONG>waddstr</STRONG> were used on the given window.
  66. The <STRONG>vwprintw</STRONG> and <STRONG>wv_printw</STRONG> routines are analogous to
  67. <STRONG>vprintf</STRONG> [see <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>] and perform a <STRONG>wprintw</STRONG> using a
  68. variable argument list. The third argument is a <STRONG>va_list</STRONG>,
  69. a pointer to a list of arguments, as defined in
  70. <STRONG>&lt;stdarg.h&gt;</STRONG>.
  71. </PRE>
  72. <H2>RETURN VALUE</H2><PRE>
  73. Routines that return an integer return <STRONG>ERR</STRONG> upon failure
  74. and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
  75. <STRONG>ERR</STRONG>") upon successful completion.
  76. X/Open defines no error conditions. In this implementa-
  77. tion, an error may be returned if it cannot allocate
  78. enough memory for the buffer used to format the results.
  79. It will return an error if the window pointer is null.
  80. </PRE>
  81. <H2>PORTABILITY</H2><PRE>
  82. The XSI Curses standard, Issue 4 describes these func-
  83. tions. The function <STRONG>vwprintw</STRONG> is marked TO BE WITHDRAWN,
  84. and is to be replaced by a function <STRONG>vw_printw</STRONG> using the
  85. <STRONG>&lt;stdarg.h&gt;</STRONG> interface. The Single Unix Specification, Ver-
  86. sion 2 states that <STRONG>vw_printw</STRONG> is preferred to <STRONG>vwprintw</STRONG>
  87. since the latter requires including <STRONG>&lt;varargs.h&gt;</STRONG>, which
  88. cannot be used in the same file as <STRONG>&lt;stdarg.h&gt;</STRONG>. This im-
  89. plementation uses <STRONG>&lt;stdarg.h&gt;</STRONG> for both, because that header
  90. is included in <STRONG>&lt;curses.h</STRONG>&gt;.
  91. </PRE>
  92. <H2>SEE ALSO</H2><PRE>
  93. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>, <STRONG>vprintf(3)</STRONG>
  94. <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
  95. </PRE>
  96. <HR>
  97. <ADDRESS>
  98. Man(1) output converted with
  99. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  100. </ADDRESS>
  101. </BODY>
  102. </HTML>