diff options
| author | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
|---|---|---|
| committer | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
| commit | ff448436b2b70771d09b8d5ff34a509dcf02f81b (patch) | |
| tree | 2f7abbba7198a4e1c4a23955bc3a539db5a7d999 /doc/html/man/curs_get_wstr.3x.html | |
| parent | f6d73a10a980bc78969c3af93665cbe7d06c3646 (diff) | |
| download | ncurses-ff448436b2b70771d09b8d5ff34a509dcf02f81b.tar.gz | |
ncurses-6.2ncurses-6.2
Diffstat (limited to 'doc/html/man/curs_get_wstr.3x.html')
| -rw-r--r-- | doc/html/man/curs_get_wstr.3x.html | 183 |
1 files changed, 102 insertions, 81 deletions
diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 4ce3cd2..4169df2 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. * + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 2002-2012,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -27,33 +27,32 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_get_wstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp @ + * @Id: curs_get_wstr.3x,v 1.20 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_get_wstr 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_get_wstr 3x</H1> -<HR> +<H1 class="no-header">curs_get_wstr 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<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> +<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> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, - <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of - wide characters from a curses terminal keyboard +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, + <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of wide characters from a + curses terminal keyboard -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> @@ -66,98 +65,120 @@ <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> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to - <STRONG>get_wch</STRONG> were made, until a newline, other end-of-line, or - end-of-file condition is processed. An end-of-file condi- - tion is represented by <STRONG>WEOF</STRONG>, as defined in <STRONG><wchar.h></STRONG>. The - newline and end-of-line conditions are represented by the - <STRONG>\n</STRONG> <STRONG>wchar_t</STRONG> value. In all instances, the end of the string - is terminated by a null <STRONG>wchar_t</STRONG>. The routine places re- - sulting values in the area pointed to by <EM>wstr</EM>. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + 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> + were made, until a newline, other end-of-line, or end-of-file condition + is processed. An end-of-file condition is represented by <STRONG>WEOF</STRONG>, as de- + fined in <STRONG><wchar.h></STRONG>. The newline and end-of-line conditions are repre- + sented by the <STRONG>\n</STRONG> <STRONG>wchar_t</STRONG> value. In all instances, the end of the + string is terminated by a null <STRONG>wchar_t</STRONG>. The routine places resulting + values in the area pointed to by <EM>wstr</EM>. - The user's erase and kill characters are interpreted. If - keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and - <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's - kill character. + The user's erase and kill characters are interpreted. If keypad mode + is on for the window, <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG> are both considered + equivalent to the user's kill character. - Characters input are echoed only if <STRONG>echo</STRONG> is currently on. - In that case, backspace is echoed as deletion of the pre- - vious character (typically a left motion). + Characters input are echoed only if <STRONG>echo</STRONG> is currently on. In that + case, backspace is echoed as deletion of the previous character (typi- + cally a left motion). - The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to - <STRONG>wget_wch</STRONG> were made. + The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to <STRONG>wget_wch</STRONG> were + made. - The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and - then a series of calls to <STRONG>get_wch</STRONG> were made. + The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and then a series + of calls to <STRONG>get_wch</STRONG> were made. - The effect of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and - then a series of calls to <STRONG>wget_wch</STRONG> were made. + The effect of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and then a se- + ries of calls to <STRONG>wget_wch</STRONG> were made. - The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> - functions are identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, - <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> functions, respectively, except - that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> characters, letting - the application prevent overflow of the input buffer. + The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> functions are + identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> func- + tions, respectively, except that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> char- + acters, letting the application prevent overflow of the input buffer. -</PRE> -<H2>NOTES</H2><PRE> - Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to - read a line that overflows the array pointed to by <STRONG>wstr</STRONG> - causes undefined results. The use of <STRONG>getn_wstr</STRONG>, - <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respectively, is - recommended. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to read a line + that overflows the array pointed to by <STRONG>wstr</STRONG> causes undefined results. + The use of <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respec- + tively, is recommended. - These functions cannot return <STRONG>KEY_</STRONG> values because there is - no way to distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> - value. + These functions cannot return <STRONG>KEY_</STRONG> values because there is no way to + distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> value. All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros. -</PRE> -<H2>RETURN VALUE</H2><PRE> - All of these functions return <STRONG>OK</STRONG> upon successful comple- - tion. Otherwise, they return <STRONG>ERR</STRONG>. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + All of these functions return <STRONG>OK</STRONG> upon successful completion. Other- + wise, they return <STRONG>ERR</STRONG>. - Functions using a window parameter return an error if it - is null. + Functions using a window parameter return an error if it is null. <STRONG>wgetn_wstr</STRONG> - returns an error if the associated call to - <STRONG>wget_wch</STRONG> failed. + returns an error if the associated call to <STRONG>wget_wch</STRONG> failed. - Functions with a "mv" prefix first perform a cursor move- - ment using <STRONG>wmove</STRONG>, and return an error if the position is - outside the window, or if the window pointer is null. + Functions with a "mv" prefix first perform a cursor movement using + <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if + the window pointer is null. -</PRE> -<H2>PORTABILITY</H2><PRE> - These functions are described in The Single Unix Specifi- - cation, Version 2. No error conditions are defined. This - implementation returns ERR if the window pointer is null, - or if the lower-level <STRONG>wget_wch</STRONG> call returns an ERR. In - the latter case, an ERR return without other data is - treated as an end-of-file condition, and the returned ar- - ray contains a <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These functions are described in The Single Unix Specification, Version + 2. No error conditions are defined. This implementation returns <STRONG>ERR</STRONG> + if the window pointer is null, or if the lower-level <STRONG>wget_wch</STRONG> call re- + turns an <STRONG>ERR</STRONG>. In the latter case, an <STRONG>ERR</STRONG> return without other data is + treated as an end-of-file condition, and the returned array contains a + <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>. - X/Open curses documents these functions to pass an array - of <STRONG>wchar_t</STRONG>, but all of the vendors implement this using - <STRONG>wint_t</STRONG>. + X/Open curses documented these functions to pass an array of <STRONG>wchar_t</STRONG> in + 1997, but that was an error because of this part of the description: + The effect of <EM>get</EM><STRONG>_</STRONG><EM>wstr()</EM> is as though a series of calls to + <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> were made, until a newline character, end-of-line + character, or end-of-file character is processed. -</PRE> -<H2>SEE ALSO</H2><PRE> + The latter function <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> can return a negative value, while + <STRONG>wchar_t</STRONG> is a unsigned type. All of the vendors implement this using + <STRONG>wint_t</STRONG>, following the standard. + + X/Open Curses, Issue 7 (2009) is unclear regarding whether the termi- + nating <EM>null</EM> <STRONG>wchar_t</STRONG> value is counted in the length parameter <EM>n</EM>. X/Open + Curses, Issue 7 revised the corresponding description of <STRONG>wgetnstr</STRONG> to + address this issue. The unrevised description of <STRONG>wget_nwstr</STRONG> can be in- + terpreted either way. This implementation counts the terminator in the + length. + + X/Open Curses does not specify what happens if the length <EM>n</EM> is nega- + tive. + + <STRONG>o</STRONG> For analogy with <STRONG>wgetnstr</STRONG>, ncurses 6.2 uses a limit (based on + <STRONG>LINE_MAX</STRONG>). + + <STRONG>o</STRONG> Some other implementations (such as Solaris xcurses) do the same, + while others (PDCurses) do not allow this. + + <STRONG>o</STRONG> NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a <STRONG>-1</STRONG> + as an indefinite number of characters. + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 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>. - <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> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |