ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_get_wstr.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 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_get_wstr.3x,v 1.20 2020/02/02 23:34:34 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_get_wstr 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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_get_wstr 3x</H1>
43 <PRE>
44 <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>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>,
51        <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of wide characters from a
52        curses terminal keyboard
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
59        <STRONG>int</STRONG> <STRONG>getn_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
60        <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>
61        <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>
62        <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>
63        <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>
64        <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>
65        <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>
66
67
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69        The  effect  of  <STRONG>get_wstr</STRONG> is as though a series of calls to <STRONG><A HREF="curs_get_wch.3x.html">get_wch(3x)</A></STRONG>
70        were made, until a newline, other end-of-line, or end-of-file condition
71        is  processed.  An end-of-file condition is represented by <STRONG>WEOF</STRONG>, as de-
72        fined in <STRONG>&lt;wchar.h&gt;</STRONG>.  The newline and end-of-line conditions are  repre-
73        sented  by  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  places  resulting
75        values in the area pointed to by <EM>wstr</EM>.
76
77        The  user's  erase and kill characters are interpreted.  If keypad mode
78        is on for the window, <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG>  are  both  considered
79        equivalent to the user's kill character.
80
81        Characters  input  are  echoed  only  if <STRONG>echo</STRONG> is currently on.  In that
82        case, backspace is echoed as deletion of the previous character  (typi-
83        cally a left motion).
84
85        The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to <STRONG>wget_wch</STRONG> were
86        made.
87
88        The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and then a  series
89        of calls to <STRONG>get_wch</STRONG> were made.
90
91        The  effect  of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and then a se-
92        ries of calls to <STRONG>wget_wch</STRONG> were made.
93
94        The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> functions  are
95        identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> func-
96        tions, respectively, except that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> char-
97        acters, letting the application prevent overflow of the input buffer.
98
99
100 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
101        Using  <STRONG>get_wstr</STRONG>,  <STRONG>mvget_wstr</STRONG>,  <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to read a line
102        that overflows the array pointed to by <STRONG>wstr</STRONG> causes  undefined  results.
103        The use of <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respec-
104        tively, is recommended.
105
106        These functions cannot return <STRONG>KEY_</STRONG> values because there is  no  way  to
107        distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> value.
108
109        All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros.
110
111
112 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
113        All  of  these  functions return <STRONG>OK</STRONG> upon successful completion.  Other-
114        wise, they return <STRONG>ERR</STRONG>.
115
116        Functions using a window parameter return an error if it is null.
117
118               <STRONG>wgetn_wstr</STRONG>
119                    returns an error if the associated call to <STRONG>wget_wch</STRONG> failed.
120
121        Functions with a "mv" prefix first  perform  a  cursor  movement  using
122        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
123        the window pointer is null.
124
125
126 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
127        These functions are described in The Single Unix Specification, Version
128        2.   No  error conditions are defined.  This implementation returns <STRONG>ERR</STRONG>
129        if the window pointer is null, or if the lower-level <STRONG>wget_wch</STRONG> call  re-
130        turns  an <STRONG>ERR</STRONG>.  In the latter case, an <STRONG>ERR</STRONG> return without other data is
131        treated as an end-of-file condition, and the returned array contains  a
132        <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
133
134        X/Open curses documented these functions to pass an array of <STRONG>wchar_t</STRONG> in
135        1997, but that was an error because of this part of the description:
136
137               The effect of <EM>get</EM><STRONG>_</STRONG><EM>wstr()</EM> is as  though  a  series  of  calls  to
138               <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM>  were  made,  until  a  newline character, end-of-line
139               character, or end-of-file character is processed.
140
141        The latter function  <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM>  can  return  a  negative  value,  while
142        <STRONG>wchar_t</STRONG>  is  a  unsigned type.  All of the vendors implement this using
143        <STRONG>wint_t</STRONG>, following the standard.
144
145        X/Open Curses, Issue 7 (2009) is unclear regarding whether  the  termi-
146        nating <EM>null</EM> <STRONG>wchar_t</STRONG> value is counted in the length parameter <EM>n</EM>.  X/Open
147        Curses, Issue 7 revised the corresponding description  of  <STRONG>wgetnstr</STRONG>  to
148        address this issue.  The unrevised description of <STRONG>wget_nwstr</STRONG> can be in-
149        terpreted either way.  This implementation counts the terminator in the
150        length.
151
152        X/Open  Curses  does  not specify what happens if the length <EM>n</EM> is nega-
153        tive.
154
155        <STRONG>o</STRONG>   For analogy with <STRONG>wgetnstr</STRONG>, ncurses  6.2  uses  a  limit  (based  on
156            <STRONG>LINE_MAX</STRONG>).
157
158        <STRONG>o</STRONG>   Some  other  implementations (such as Solaris xcurses) do the same,
159            while others (PDCurses) do not allow this.
160
161        <STRONG>o</STRONG>   NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a  <STRONG>-1</STRONG>
162            as an indefinite number of characters.
163
164
165 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
166        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>.
167
168
169
170                                                              <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
171 </PRE>
172 <div class="nav">
173 <ul>
174 <li><a href="#h2-NAME">NAME</a></li>
175 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
176 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
177 <li><a href="#h2-NOTES">NOTES</a></li>
178 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
179 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
180 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
181 </ul>
182 </div>
183 </BODY>
184 </HTML>