doc/html/man/curs_get_wstr.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-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_get_wstr.3x,v 1.46 2024/04/13 22:14:06 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 2024-04-13 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_get_wstr 3x 2024-04-13 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>                Library calls               <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 a wide-character string from  a  <EM>curses</EM>
  52        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
  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>
  67
  68
  69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  70        The  function  <STRONG>wgetn_wstr</STRONG>  is  equivalent  to  a  series  of  calls  to
  71        <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG> until a newline or carriage return terminates the series:
  72
  73        <STRONG>o</STRONG>   The terminating character is not included in the returned string.
  74
  75        <STRONG>o</STRONG>   An end-of-file condition is represented  by  <STRONG>WEOF</STRONG>,  as  defined  in
  76            <STRONG>&lt;wchar.h&gt;</STRONG>.
  77
  78        <STRONG>o</STRONG>   In  all  instances,  the  end of the string is terminated by a null
  79            <STRONG>wchar_t</STRONG>.
  80
  81        <STRONG>o</STRONG>   The function stores the result in the area pointed to by  the  <EM>wstr</EM>
  82            parameter.
  83
  84        <STRONG>o</STRONG>   The function reads at most <EM>n</EM> characters, thus preventing a possible
  85            overflow of the input buffer.
  86
  87            Any attempt to enter more characters (other  than  the  terminating
  88            newline or carriage return) causes a beep.
  89
  90            Function keys also cause a beep and are ignored.
  91
  92        The user's <EM>erase</EM> and <EM>kill</EM> characters are interpreted:
  93
  94        <STRONG>o</STRONG>   The  <EM>erase</EM>  character (e.g., <STRONG>^H</STRONG>) erases the character at the end of
  95            the buffer, moving the cursor to the left.
  96
  97            If <EM>keypad</EM> mode is on for the window, <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG> are
  98            both considered equivalent to the user's <EM>erase</EM> character.
  99
 100        <STRONG>o</STRONG>   The <EM>kill</EM> character (e.g., <STRONG>^U</STRONG>) erases the entire buffer, leaving the
 101            cursor at the beginning of the buffer.
 102
 103        Characters input are echoed only if <STRONG>echo</STRONG>  is  currently  on.   In  that
 104        case,  backspace  is  echoed  as  deletion  of  the  previous character
 105        (typically a left motion).
 106
 107        The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> functions  are
 108        identical  to  the  <STRONG>get_wstr</STRONG>,  <STRONG>mvget_wstr</STRONG>,  <STRONG>mvwget_wstr</STRONG>,  and <STRONG>wget_wstr</STRONG>
 109        functions, respectively, except that the <STRONG>*n_*</STRONG> versions read at  most  <EM>n</EM>
 110        characters,  letting  the  application  prevent  overflow  of the input
 111        buffer.
 112
 113
 114 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 115        All  of  these  functions  return  the  integer  <STRONG>OK</STRONG>   upon   successful
 116        completion.  If unsuccessful, they return <STRONG>ERR</STRONG>.
 117
 118        X/Open defines no error conditions.
 119
 120        In this implementation, these functions return an error
 121
 122        <STRONG>o</STRONG>   if the window pointer is null,
 123
 124        <STRONG>o</STRONG>   if its timeout expires without having any data, or
 125
 126        <STRONG>o</STRONG>   if the associated call to <STRONG>wget_wch</STRONG> failed.
 127
 128        Functions  with  a  "mv"  prefix  first perform a cursor movement using
 129        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
 130        the window pointer is null.
 131
 132
 133 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 134        Any of these functions other than <STRONG>wgetn_wstr</STRONG> may be macros.
 135
 136        Using  <STRONG>get_wstr</STRONG>,  <STRONG>mvget_wstr</STRONG>,  <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to read a line
 137        that overflows the array pointed to by <STRONG>wstr</STRONG> causes  undefined  results.
 138        The   use  of  <STRONG>getn_wstr</STRONG>,  <STRONG>mvgetn_wstr</STRONG>,  <STRONG>mvwgetn_wstr</STRONG>,  or  <STRONG>wgetn_wstr</STRONG>,
 139        respectively, is recommended.
 140
 141        These functions cannot return <STRONG>KEY_</STRONG> values because there is  no  way  to
 142        distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> value.
 143
 144
 145 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 146        These functions are described in The Single Unix Specification, Version
 147        2.  No error conditions are defined.
 148
 149        This implementation returns <STRONG>ERR</STRONG> if the window pointer is  null,  or  if
 150        the  lower-level  <STRONG>wget_wch</STRONG> call returns an <STRONG>ERR</STRONG>.  In the latter case, an
 151        <STRONG>ERR</STRONG> return without other data is treated as an  end-of-file  condition,
 152        and the returned array contains a <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
 153
 154        X/Open curses documented these functions to pass an array of <STRONG>wchar_t</STRONG> in
 155        1997, but that was an error because of this part of the description:
 156
 157               The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to <STRONG>get_wch</STRONG>
 158               were  made, until a newline character, end-of-line character, or
 159               end-of-file character is processed.
 160
 161        The latter function <EM>get</EM><STRONG>_</STRONG><EM>wch</EM> can return a negative value, while  <STRONG>wchar_t</STRONG>
 162        is  a  unsigned  type.  All of the vendors implement this using <STRONG>wint_t</STRONG>,
 163        following the standard.
 164
 165        X/Open  Curses,  Issue  7  (2009)  is  unclear  regarding  whether  the
 166        terminating  <EM>null</EM>  <STRONG>wchar_t</STRONG>  value is counted in the length parameter <EM>n</EM>.
 167        X/Open  Curses,  Issue  7  revised  the  corresponding  description  of
 168        <STRONG>wgetnstr</STRONG>   to   address  this  issue.   The  unrevised  description  of
 169        <STRONG>wget_nwstr</STRONG> can be interpreted either way.  This  implementation  counts
 170        the terminator in the length.
 171
 172        X/Open  Curses  does  not  specify  what  happens  if  the  length <EM>n</EM> is
 173        negative.
 174
 175        <STRONG>o</STRONG>   For analogy with <STRONG>wgetnstr</STRONG>, <EM>ncurses</EM>  6.2  uses  a  limit  (based  on
 176            <STRONG>LINE_MAX</STRONG>).
 177
 178        <STRONG>o</STRONG>   Some  other  implementations (such as Solaris xcurses) do the same,
 179            while others (PDCurses) do not allow this.
 180
 181        <STRONG>o</STRONG>   NetBSD 7 curses imitates <EM>ncurses</EM> 6.1 in this regard, treating a  <STRONG>-1</STRONG>
 182            as an indefinite number of characters.
 183
 184
 185 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 186        <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>  describes  comparable functions of the <EM>ncurses</EM> library
 187        in its non-wide-character configuration.
 188
 189        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
 190
 191
 192
 193 ncurses 6.4                       2024-04-13                 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
 194 </PRE>
 195 <div class="nav">
 196 <ul>
 197 <li><a href="#h2-NAME">NAME</a></li>
 198 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 199 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 200 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 201 <li><a href="#h2-NOTES">NOTES</a></li>
 202 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 203 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 204 </ul>
 205 </div>
 206 </BODY>
 207 </HTML>