doc/html/man/curs_addwstr.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2019,2020 Thomas E. Dickey                                     *
   4   * Copyright 2002-2012,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_addwstr.3x,v 1.15 2020/10/17 23:12:22 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_addwstr 3X</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_addwstr 3X</H1>
  43 <PRE>
  44 <B><A HREF="curs_addwstr.3X.html">curs_addwstr(3X)</A></B>                                              <B><A HREF="curs_addwstr.3X.html">curs_addwstr(3X)</A></B>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <B>addwstr</B>, <B>addnwstr</B>, <B>waddwstr</B>, <B>waddnwstr</B>, <B>mvaddwstr</B>, <B>mvaddnwstr</B>,
  51        <B>mvwaddwstr</B>, <B>mvwaddnwstr</B> - add a string of wide characters to a <B>curses</B>
  52        window and advance cursor
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <B>#include</B> <B>&lt;curses.h&gt;</B>
  57
  58        <B>int</B> <B>addwstr(const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
  59        <B>int</B> <B>addnwstr(const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  60        <B>int</B> <B>waddwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
  61        <B>int</B> <B>waddnwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  62
  63        <B>int</B> <B>mvaddwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
  64        <B>int</B> <B>mvaddnwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  65        <B>int</B> <B>mvwaddwstr(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>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
  66        <B>int</B> <B>mvwaddnwstr(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>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  67
  68
  69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  70        These  functions  write the characters of the (null-terminated) <B>wchar_t</B>
  71        character string <I>wstr</I> on the given window.  It is similar to construct-
  72        ing a <B>cchar_t</B> for each wchar_t in the string, then calling <B>wadd_wch</B> for
  73        the resulting <B>cchar_t</B>.
  74
  75        The <I>mv</I> functions perform cursor movement once, before writing any char-
  76        acters.  Thereafter, the cursor is advanced as a side-effect of writing
  77        to the window.
  78
  79        The four functions with <I>n</I> as the last argument write at most <I>n</I>  <B>wchar_t</B>
  80        characters,  or  until a terminating null is reached.  If <I>n</I> is -1, then
  81        the entire string will be added.
  82
  83
  84 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  85        All functions return the integer <B>ERR</B> upon failure and <B>OK</B> on success.
  86
  87        X/Open does not define any error conditions.  This  implementation  re-
  88        turns an error
  89
  90        <B>o</B>   if the window pointer is null or
  91
  92        <B>o</B>   if the string pointer is null or
  93
  94        <B>o</B>   if the corresponding calls to <B>wadd_wch</B> return an error.
  95
  96        Functions  with  a  "mv"  prefix  first perform a cursor movement using
  97        <B>wmove</B>, and return an error if the position is outside the window, or if
  98        the window pointer is null.
  99
 100
 101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 102        All of these functions except <B>waddnwstr</B> may be macros.
 103
 104
 105 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 106        These functions are described in the XSI Curses standard, Issue 4.
 107
 108
 109 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 110        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_add_wch.3X.html">curs_add_wch(3X)</A></B>
 111
 112
 113
 114                                                               <B><A HREF="curs_addwstr.3X.html">curs_addwstr(3X)</A></B>
 115 </PRE>
 116 <div class="nav">
 117 <ul>
 118 <li><a href="#h2-NAME">NAME</a></li>
 119 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 120 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 122 <li><a href="#h2-NOTES">NOTES</a></li>
 123 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 124 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 125 </ul>
 126 </div>
 127 </BODY>
 128 </HTML>