Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_addwstr.3x.html
blob: c24cfa2bfecb2d5447198064b54a207fc962bdaa [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]3 * Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]4 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]29 * @Id: curs_addwstr.3x,v 1.11 2012/11/03 22:57:31 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]34<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_addwstr 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]41<H1 class="no-header">curs_addwstr 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>addwstr</STRONG>, <STRONG>addnwstr</STRONG>, <STRONG>waddwstr</STRONG>, <STRONG>waddnwstr</STRONG>, <STRONG>mvaddwstr</STRONG>,
51 <STRONG>mvaddnwstr</STRONG>, <STRONG>mvwaddwstr</STRONG>, <STRONG>mvwaddnwstr</STRONG> - add a string of wide
52 characters to a <STRONG>curses</STRONG> window and advance cursor
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59 <STRONG>int</STRONG> <STRONG>addwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>addnwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>waddwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>waddnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvaddwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvaddnwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwaddwstr(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>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
66 <STRONG>int</STRONG> <STRONG>mvwaddnwstr(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>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
67
68
69</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]70<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71 These functions write the characters of the (null-termi-
72 nated) <STRONG>wchar_t</STRONG> character string <EM>wstr</EM> on the given window.
73 It is similar to constructing a <STRONG>cchar_t</STRONG> for each wchar_t
74 in the string, then calling <STRONG>wadd_wch</STRONG> for the resulting
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]75 <STRONG>cchar_t</STRONG>.
76
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]77 The <EM>mv</EM> functions perform cursor movement once, before
78 writing any characters. Thereafter, the cursor is ad-
79 vanced as a side-effect of writing to the window.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]80
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]81 The four functions with <EM>n</EM> as the last argument write at
82 most <EM>n</EM> <STRONG>wchar_t</STRONG> characters, or until a terminating null is
83 reached. If <EM>n</EM> is -1, then the entire string will be
84 added.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]85
86
87</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]88<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
89 All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
90 on success.
91
92 X/Open does not define any error conditions. This imple-
93 mentation returns an error
94
95 <STRONG>o</STRONG> if the window pointer is null or
96
97 <STRONG>o</STRONG> if the string pointer is null or
98
99 <STRONG>o</STRONG> if the corresponding calls to <STRONG>wadd_wch</STRONG> return an er-
100 ror.
101
102 Functions with a "mv" prefix first perform a cursor move-
103 ment using <STRONG>wmove</STRONG>, and return an error if the position is
104 outside the window, or if the window pointer is null.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]105
106
107</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]108<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
109 All of these functions except <STRONG>waddnwstr</STRONG> may be macros.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]110
111
112</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]113<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
114 These functions are described in the XSI Curses standard,
115 Issue 4.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]116
117
118</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]119<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]120 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
121
122
123
124 <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
125</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]126<div class="nav">
127<ul>
128<li><a href="#h2-NAME">NAME</a></li>
129<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
130<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
131<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
132<li><a href="#h2-NOTES">NOTES</a></li>
133<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
135</ul>
136</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]137</BODY>
138</HTML>