1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 2002-2006,2010 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_get_wstr.3x,v 1.8 2010/12/04 18:36:44 tom Exp @
34 <TITLE>curs_get_wstr
3x
</TITLE>
35 <link rev=made
href=
"mailto:bug-ncurses@gnu.org">
36 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
39 <H1>curs_get_wstr
3x
</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
50 <STRONG>get_wstr
</STRONG>,
<STRONG>getn_wstr
</STRONG>,
<STRONG>wget_wstr
</STRONG>,
<STRONG>wgetn_wstr
</STRONG>,
<STRONG>mvget_wstr
</STRONG>,
51 <STRONG>mvgetn_wstr
</STRONG>,
<STRONG>mvwget_wstr
</STRONG>,
<STRONG>mvwgetn_wstr
</STRONG> - get an array of
52 wide characters from a curses terminal keyboard
56 <H2>SYNOPSIS
</H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
59 <STRONG>int
</STRONG> <STRONG>get_wstr(wint_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>);
</STRONG>
60 <STRONG>int
</STRONG> <STRONG>getn_wstr(wint_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
61 <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>
62 <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>
63 <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>
64 <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>
65 <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>
66 <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>
70 <H2>DESCRIPTION
</H2><PRE>
71 The effect of
<STRONG>get_wstr
</STRONG> is as though a series of calls to
72 <STRONG>get_wch
</STRONG> were made, until a newline, other end-of-line, or
73 end-of-file condition is processed. An end-of-file condi-
74 tion is represented by
<STRONG>WEOF
</STRONG>, as defined in
<STRONG><wchar.h
></STRONG>. The
75 newline and end-of-line conditions are represented by the
76 <STRONG>\n
</STRONG> <STRONG>wchar_t
</STRONG> value. In all instances, the end of the string
77 is terminated by a null
<STRONG>wchar_t
</STRONG>. The routine places re-
78 sulting values in the area pointed to by
<EM>wstr
</EM>.
80 The user's erase and kill characters are interpreted. If
81 keypad mode is on for the window,
<STRONG>KEY_LEFT
</STRONG> and
82 <STRONG>KEY_BACKSPACE
</STRONG> are both considered equivalent to the user's
85 Characters input are echoed only if
<STRONG>echo
</STRONG> is currently on.
86 In that case, backspace is echoed as deletion of the pre-
87 vious character (typically a left motion).
89 The effect of
<STRONG>wget_wstr
</STRONG> is as though a series of calls to
90 <STRONG>wget_wch
</STRONG> were made.
92 The effect of
<STRONG>mvget_wstr
</STRONG> is as though a call to
<STRONG>move
</STRONG> and
93 then a series of calls to
<STRONG>get_wch
</STRONG> were made.
95 The effect of
<STRONG>mvwget_wstr
</STRONG> is as though a call to
<STRONG>wmove
</STRONG> and
96 then a series of calls to
<STRONG>wget_wch
</STRONG> were made.
98 The
<STRONG>getn_wstr
</STRONG>,
<STRONG>mvgetn_wstr
</STRONG>,
<STRONG>mvwgetn_wstr
</STRONG>, and
<STRONG>wgetn_wstr
</STRONG>
99 functions are identical to the
<STRONG>get_wstr
</STRONG>,
<STRONG>mvget_wstr
</STRONG>,
100 <STRONG>mvwget_wstr
</STRONG>, and
<STRONG>wget_wstr
</STRONG> functions, respectively, except
101 that the
<STRONG>*n_*
</STRONG> versions read at most
<EM>n
</EM> characters, letting
102 the application prevent overflow of the input buffer.
107 Using
<STRONG>get_wstr
</STRONG>,
<STRONG>mvget_wstr
</STRONG>,
<STRONG>mvwget_wstr
</STRONG>, or
<STRONG>wget_wstr
</STRONG> to
108 read a line that overflows the array pointed to by
<STRONG>wstr
</STRONG>
109 causes undefined results. The use of
<STRONG>getn_wstr
</STRONG>,
110 <STRONG>mvgetn_wstr
</STRONG>,
<STRONG>mvwgetn_wstr
</STRONG>, or
<STRONG>wgetn_wstr
</STRONG>, respectively, is
113 These functions cannot return
<STRONG>KEY_
</STRONG> values because there is
114 no way to distinguish a
<STRONG>KEY_
</STRONG> value from a valid
<STRONG>wchar_t
</STRONG>
117 All of these routines except
<STRONG>wgetn_wstr
</STRONG> may be macros.
121 <H2>RETURN VALUES
</H2><PRE>
122 All of these functions return
<STRONG>OK
</STRONG> upon successful comple-
123 tion. Otherwise, they return
<STRONG>ERR
</STRONG>.
125 Functions using a window parameter return an error if it
128 <STRONG>wgetn_wstr
</STRONG>
129 returns an error if the associated call to
130 <STRONG>wget_wch
</STRONG> failed.
132 Functions with a
"mv" prefix first perform a cursor move-
133 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
134 outside the window, or if the window pointer is null.
138 <H2>PORTABILITY
</H2><PRE>
139 These functions are described in The Single Unix Specifi-
140 cation, Version
2. No error conditions are defined. This
141 implementation returns ERR if the window pointer is null,
142 or if the lower-level
<STRONG>wget_wch
</STRONG> call returns an ERR. In
143 the latter case, an ERR return without other data is
144 treated as an end-of-file condition, and the returned ar-
145 ray contains a
<STRONG>WEOF
</STRONG> followed by a null
<STRONG>wchar_t
</STRONG>.
147 X/Open curses documents these functions to pass an array
148 of
<STRONG>wchar_t
</STRONG>, but all of the vendors implement this using
149 <STRONG>wint_t
</STRONG>.
153 <H2>SEE ALSO
</H2><PRE>
154 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>.
158 <STRONG><A HREF=
"curs_get_wstr.3x.html">curs_get_wstr(
3x)
</A></STRONG>
162 Man(
1) output converted with
163 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>