1<!-- 2 **************************************************************************** 3 * Copyright 2019-2023,2024 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.39 2024/04/20 21:20:07 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 2024-04-20 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">curs_add_wchstr 3x 2024-04-20 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>, <STRONG>mvadd_wchstr</STRONG>, 51 <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG> - add a <EM>curses</EM> complex 52 character string to a window 53 54 55</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 57 58 <STRONG>int</STRONG> <STRONG>add_wchstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> 59 <STRONG>int</STRONG> <STRONG>wadd_wchstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> 60 <STRONG>int</STRONG> <STRONG>mvadd_wchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> 61 <STRONG>int</STRONG> <STRONG>mvwadd_wchstr(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>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> 62 63 <STRONG>int</STRONG> <STRONG>add_wchnstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> 64 <STRONG>int</STRONG> <STRONG>wadd_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> 65 <STRONG>int</STRONG> <STRONG>mvadd_wchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> 66 <STRONG>int</STRONG> <STRONG>mvwadd_wchnstr(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>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> 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 <EM>wchstr</EM> into the window image structure starting at the current cursor 72 position. 73 74 The four functions with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements, 75 but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the whole array is 76 copied, to the maximum number of characters that will fit on the line. 77 78 The window cursor is <EM>not</EM> advanced. These functions are faster than 79 <STRONG>waddnstr</STRONG>. On the other hand: 80 81 <STRONG>o</STRONG> they do not perform checking (such as for the newline, backspace, 82 or carriage return characters), 83 84 <STRONG>o</STRONG> they do not advance the current cursor position, 85 86 <STRONG>o</STRONG> they do not expand other control characters to ^-escapes, and 87 88 <STRONG>o</STRONG> they truncate the string if it crosses the right margin, rather 89 than wrapping it around to the new line. 90 91 These functions end successfully on encountering a null <STRONG>cchar_t</STRONG>, or 92 when they have filled the current line. If a complex character cannot 93 completely fit at the end of the current line, the remaining columns 94 are filled with the background character and rendition. 95 96 97</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 98 All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success. 99 100 X/Open Curses does not specify any error conditions. This 101 implementation returns an error 102 103 <STRONG>o</STRONG> if the <EM>win</EM> parameter is null or 104 105 <STRONG>o</STRONG> if the <EM>wchstr</EM> parameter is null. 106 107 Functions prefixed with "mv" first perform cursor movement and fail if 108 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. 109 110 111</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> 112 All functions except <STRONG>wadd_wchnstr</STRONG> may be macros. 113 114 115</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 116 These functions are described in X/Open Curses, Issue 4. 117 118 119</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 120 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library 121 in its non-wide-character configuration. 122 123 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> 124 125 126 127ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> 128</PRE> 129<div class="nav"> 130<ul> 131<li><a href="#h2-NAME">NAME</a></li> 132<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 133<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 134<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 135<li><a href="#h2-NOTES">NOTES</a></li> 136<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 137<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 138</ul> 139</div> 140</BODY> 141</HTML> 142