2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 2002-2012,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_inwstr.3x,v 1.14 2020/10/17 23:22:11 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_inwstr 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">
42 <H1 class="no-header">curs_inwstr 3X</H1>
44 <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B> <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <B>inwstr</B>, <B>innwstr</B>, <B>winwstr</B>, <B>winnwstr</B>, <B>mvinwstr</B>, <B>mvinnwstr</B>, <B>mvwinwstr</B>,
51 <B>mvwinnwstr</B> - get a string of <B>wchar_t</B> characters from a curses window
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <B>#include</B> <B><curses.h></B>
57 <B>int</B> <B>inwstr(wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
58 <B>int</B> <B>innwstr(wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
59 <B>int</B> <B>winwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
60 <B>int</B> <B>winnwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
62 <B>int</B> <B>mvinwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
63 <B>int</B> <B>mvinnwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
64 <B>int</B> <B>mvwinwstr(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>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
65 <B>int</B> <B>mvwinnwstr(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>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 These routines return a string of <B>wchar_t</B> wide characters in <I>wstr</I>,
70 extracted starting at the current cursor position in the named window.
72 The four functions with <I>n</I> as the last argument return a leading
73 substring at most <I>n</I> characters long (exclusive of the trailing NUL).
74 Transfer stops at the end of the current line, or when <I>n</I> characters
75 have been stored at the location referenced by <I>wstr</I>.
77 If the size <I>n</I> is not large enough to store a complete complex
78 character, an error is generated.
81 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
82 All routines except <B>winnwstr</B> may be macros.
84 Each cell in the window holds a complex character (i.e., base- and
85 combining-characters) together with attributes and color. These
86 functions store only the wide characters, ignoring attributes and
87 color. Use <B>in_wchstr</B> to return the complex characters from a window.
90 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
91 All routines return <B>ERR</B> upon failure. Upon successful completion, the
92 *<B>inwstr</B> routines return <B>OK</B>, and the *<B>innwstr</B> routines return the number
93 of characters read into the string.
95 Functions with a "mv" prefix first perform a cursor movement using
96 <B>wmove</B>, and return an error if the position is outside the window, or if
97 the window pointer is null.
100 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
101 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>, <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>
105 <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>
109 <li><a href="#h2-NAME">NAME</a></li>
110 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
111 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
112 <li><a href="#h2-NOTES">NOTES</a></li>
113 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
114 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>