doc/html/man/curs_printw.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998,2000 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.12 2002/07/20 15:01:43 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
  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
  49
  50 </PRE>
  51 <H2>SYNOPSIS</H2><PRE>
  52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  53
  54        <STRONG>int</STRONG> <STRONG>printw(char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  55        <STRONG>int</STRONG> <STRONG>wprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  56        <STRONG>int</STRONG> <STRONG>mvprintw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>mvwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>vwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>vw_printw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
  60
  61
  62 </PRE>
  63 <H2>DESCRIPTION</H2><PRE>
  64        The <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG> and <STRONG>mvwprintw</STRONG>  routines  are
  65        analogous  to  <STRONG>printf</STRONG>  [see  <STRONG><A HREF="printf.3S.html">printf(3S)</A></STRONG>].   In effect, the
  66        string that would be output by <STRONG>printf</STRONG> is output instead as
  67        though <STRONG>waddstr</STRONG> were used on the given window.
  68
  69        The  <STRONG>vwprintw</STRONG>  and  <STRONG>wv_printw</STRONG>  routines  are  analogous to
  70        <STRONG>vprintf</STRONG> [see <STRONG><A HREF="printf.3S.html">printf(3S)</A></STRONG>] and perform  a  <STRONG>wprintw</STRONG>  using  a
  71        variable  argument list.  The third argument is a <STRONG>va_list</STRONG>,
  72        a  pointer  to  a  list  of  arguments,  as   defined   in
  73        <STRONG>&lt;stdarg.h&gt;</STRONG>.
  74
  75
  76 </PRE>
  77 <H2>RETURN VALUE</H2><PRE>
  78        Routines  that  return  an integer return <STRONG>ERR</STRONG> upon failure
  79        and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value  other  than
  80        <STRONG>ERR</STRONG>") upon successful completion.
  81
  82
  83 </PRE>
  84 <H2>PORTABILITY</H2><PRE>
  85        The  XSI  Curses  standard,  Issue 4 describes these func-
  86        tions.  The function <STRONG>vwprintw</STRONG> is marked TO  BE  WITHDRAWN,
  87        and  is  to  be replaced by a function <STRONG>vw_printw</STRONG> using the
  88        <STRONG>&lt;stdarg.h&gt;</STRONG> interface.  The Single Unix Specification, Ver-
  89        sion  2  states  that  <STRONG>vw_printw</STRONG>  is preferred to <STRONG>vwprintw</STRONG>
  90        since the latter  requires  including  <STRONG>&lt;varargs.h&gt;</STRONG>,  which
  91        cannot  be  used  in  the  same  file as <STRONG>&lt;stdarg.h&gt;</STRONG>.  This
  92        implementation uses  <STRONG>&lt;stdarg.h&gt;</STRONG>  for  both,  because  that
  93        header is included in <STRONG>&lt;curses.h</STRONG>&gt;.
  94
  95
  96 </PRE>
  97 <H2>SEE ALSO</H2><PRE>
  98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3S.html">printf(3S)</A></STRONG>, <STRONG>vprintf(3S)</STRONG>
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109 </PRE>
 110 <HR>
 111 <ADDRESS>
 112 Man(1) output converted with
 113 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 114 </ADDRESS>
 115 </BODY>
 116 </HTML>