ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_add_wchstr.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_add_wchstr.3x,v 1.15 2020/12/19 21:39:06 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_add_wchstr 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_add_wchstr 3X</H1>
43 <PRE>
44 <B><A HREF="curs_add_wchstr.3X.html">curs_add_wchstr(3X)</A></B>                                        <B><A HREF="curs_add_wchstr.3X.html">curs_add_wchstr(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>add_wchstr</B>, <B>add_wchnstr</B>, <B>wadd_wchstr</B>, <B>wadd_wchnstr</B>, <B>mvadd_wchstr</B>,
51        <B>mvadd_wchnstr</B>, <B>mvwadd_wchstr</B>, <B>mvwadd_wchnstr</B> - add an array of complex
52        characters (and attributes) to a curses window
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>add_wchstr(const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
59        <B>int</B> <B>add_wchnstr(const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
60        <B>int</B> <B>wadd_wchstr(WINDOW</B> <B>*</B> <I>win</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
61        <B>int</B> <B>wadd_wchnstr(WINDOW</B> <B>*</B> <I>win</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
62
63        <B>int</B> <B>mvadd_wchstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
64        <B>int</B> <B>mvadd_wchnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>cchar_t</B> <B>*</B><I>wchstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
65        <B>int</B> <B>mvwadd_wchstr(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>cchar_t</B> <B>*</B><I>wchstr</I><B>);</B>
66        <B>int</B> <B>mvwadd_wchnstr(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>cchar_t</B> <B>*</B><I>wchstr</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 copy the (null-terminated) array of complex characters
71        <I>wchstr</I> into the window image structure starting at the  current  cursor
72        position.   The four functions with <I>n</I> as the last argument copy at most
73        <I>n</I> elements, but no more than will fit on the line.  If  <B>n</B>=<B>-1</B>  then  the
74        whole  array  is  copied, to the maximum number of characters that will
75        fit on the line.
76
77        The window cursor is <I>not</I> advanced.  These functions  work  faster  than
78        <B>waddnstr</B>.  On the other hand:
79
80        <B>o</B>   they  do  not perform checking (such as for the newline, backspace,
81            or carriage return characters),
82
83        <B>o</B>   they do not advance the current cursor position,
84
85        <B>o</B>   they do not expand other control characters to ^-escapes, and
86
87        <B>o</B>   they truncate the string if it crosses  the  right  margin,  rather
88            than wrapping it around to the new line.
89
90        These  functions  end  successfully  on encountering a null <I>cchar</I><B>_</B><I>t</I>, or
91        when they have filled the current line.  If a complex character  cannot
92        completely  fit  at  the end of the current line, the remaining columns
93        are filled with the background character and rendition.
94
95
96 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
97        All functions return the integer <B>ERR</B> upon failure and <B>OK</B> on success.
98
99        X/Open does not define any error conditions.  This  implementation  re-
100        turns an error if the window pointer is null.
101
102        Functions  with  a  "mv"  prefix  first perform a cursor movement using
103        <B>wmove</B>, and return an error if the position is outside the window, or if
104        the window pointer is null.
105
106
107 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        All functions except <B>wadd_wchnstr</B> may be macros.
109
110
111 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
112        These entry points are described in the XSI Curses standard, Issue 4.
113
114
115 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
116        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_addwstr.3X.html">curs_addwstr(3X)</A></B>.
117
118        Comparable  functions in the narrow-character (ncurses) library are de-
119        scribed in <B><A HREF="curs_addchstr.3X.html">curs_addchstr(3X)</A></B>.
120
121
122
123                                                            <B><A HREF="curs_add_wchstr.3X.html">curs_add_wchstr(3X)</A></B>
124 </PRE>
125 <div class="nav">
126 <ul>
127 <li><a href="#h2-NAME">NAME</a></li>
128 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131 <li><a href="#h2-NOTES">NOTES</a></li>
132 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
133 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
134 </ul>
135 </div>
136 </BODY>
137 </HTML>