- 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.
-
- 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 function <STRONG>wgetn_wstr</STRONG> is equivalent to a series of calls to
+ <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG> until a newline or carriage return terminates the series:
+
+ <STRONG>o</STRONG> The terminating character is not included in the returned string.
+
+ <STRONG>o</STRONG> An end-of-file condition is represented by <STRONG>WEOF</STRONG>, as defined in
+ <STRONG><wchar.h></STRONG>.
+
+ <STRONG>o</STRONG> In all instances, the end of the string is terminated by a null
+ <STRONG>wchar_t</STRONG>.
+
+ <STRONG>o</STRONG> The function stores the result in the area pointed to by the <EM>wstr</EM>
+ parameter.
+
+ <STRONG>o</STRONG> The function reads at most <EM>n</EM> characters, thus preventing a possible
+ overflow of the input buffer.
+
+ Any attempt to enter more characters (other than the terminating
+ newline or carriage return) causes a beep.
+
+ Function keys also cause a beep and are ignored.