2 ****************************************************************************
3 * Copyright (c) 2002-2012,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: curs_get_wstr.3x,v 1.11 2017/03/04 21:24:04 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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">
36 <TITLE>curs_get_wstr 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">
41 <H1 class="no-header">curs_get_wstr 3x</H1>
43 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>,
50 <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of
51 wide characters from a curses terminal keyboard
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>getn_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>wget_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>wgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>mvget_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>mvgetn_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvwget_wstr(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>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwgetn_wstr(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>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to
69 <STRONG><A HREF="curs_get_wch.3x.html">get_wch(3x)</A></STRONG> were made, until a newline, other end-of-line,
70 or end-of-file condition is processed. An end-of-file
71 condition is represented by <STRONG>WEOF</STRONG>, as defined in <STRONG><wchar.h></STRONG>.
72 The newline and end-of-line conditions are represented by
73 the <STRONG>\n</STRONG> <STRONG>wchar_t</STRONG> value. In all instances, the end of the
74 string is terminated by a null <STRONG>wchar_t</STRONG>. The routine
75 places resulting values in the area pointed to by <EM>wstr</EM>.
77 The user's erase and kill characters are interpreted. If
78 keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and
79 <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's
82 Characters input are echoed only if <STRONG>echo</STRONG> is currently on.
83 In that case, backspace is echoed as deletion of the pre-
84 vious character (typically a left motion).
86 The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to
87 <STRONG>wget_wch</STRONG> were made.
89 The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and
90 then a series of calls to <STRONG>get_wch</STRONG> were made.
92 The effect of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and
93 then a series of calls to <STRONG>wget_wch</STRONG> were made.
95 The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG>
96 functions are identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>,
97 <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> functions, respectively, except
98 that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> characters, letting
99 the application prevent overflow of the input buffer.
102 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
103 Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to
104 read a line that overflows the array pointed to by <STRONG>wstr</STRONG>
105 causes undefined results. The use of <STRONG>getn_wstr</STRONG>,
106 <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respectively, is
109 These functions cannot return <STRONG>KEY_</STRONG> values because there is
110 no way to distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG>
113 All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros.
116 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
117 All of these functions return <STRONG>OK</STRONG> upon successful comple-
118 tion. Otherwise, they return <STRONG>ERR</STRONG>.
120 Functions using a window parameter return an error if it
123 <STRONG>wgetn_wstr</STRONG>
124 returns an error if the associated call to
125 <STRONG>wget_wch</STRONG> failed.
127 Functions with a "mv" prefix first perform a cursor move-
128 ment using <STRONG>wmove</STRONG>, and return an error if the position is
129 outside the window, or if the window pointer is null.
132 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
133 These functions are described in The Single Unix Specifi-
134 cation, Version 2. No error conditions are defined. This
135 implementation returns ERR if the window pointer is null,
136 or if the lower-level <STRONG>wget_wch</STRONG> call returns an ERR. In
137 the latter case, an ERR return without other data is
138 treated as an end-of-file condition, and the returned ar-
139 ray contains a <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
141 X/Open curses documented these functions to pass an array
142 of <STRONG>wchar_t</STRONG> in 1997, but that was an error because of this
143 part of the description:
145 The effect of <EM>get</EM><STRONG>_</STRONG><EM>wstr()</EM> is as though a series of
146 calls to <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> were made, until a newline char-
147 acter, end-of-line character, or end-of-file char-
150 The latter function <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> can return a negative value,
151 while <STRONG>wchar_t</STRONG> is a unsigned type. All of the vendors im-
152 plement this using <STRONG>wint_t</STRONG>, following the standard.
155 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
156 Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>.
160 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
164 <li><a href="#h2-NAME">NAME</a></li>
165 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
166 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
167 <li><a href="#h2-NOTES">NOTES</a></li>
168 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
169 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
170 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>