STANDARDS

Refer to the
standards(5)
reference page for more information
about industry standards and associated tags.

DESCRIPTION

The effect of
get_wstr
is as though a series of calls
to
get_wch
were made, until a newline, end-of-line, or
end-of-file character is processed. An end-of-file character is represented
by
WEOF, as defined in
<wchar.h>. A newline or end-of-line character is represented as its
wchar_t
value. In all instances, the end of the string is terminated
by a null
wchar_t. The routine places resulting values
in the area pointed to by
wstr. The routine's interpretation
of the user's erase and kill characters affects the sequence of characters
returned.

The effect of
wget_wstr
is as though a series of
calls to
wget_wch
were made.

The effect of
mvget_wstr
is as though a call to
move
and then a series of calls to
get_wch
were
made.

The effect of
mvwget_wstr
is as though a call to
wmove
and then a series of calls to
wget_wch
were made.

The
getn_wstr,
mvgetn_wstr,
mvwgetn_wstr, and
wgetn_wstr
functions are identical
to the
get_wstr,
mvget_wstr,
mvwget_wstr, and
wget_wstr
functions, respectively,
except that the
*n_*
versions read at most
n
characters, letting the application prevent overflow of the
input buffer.

NOTES

Using
get_wstr,
mvget_wstr,
mvwget_wstr, or
wget_wstr
to read a line that
overflows the array pointed to by
wstr
causes undefined
results. The use of
getn_wstr,
mvgetn_wstr,
mvwgetn_wstr, or
wgetn_wstr, respectively, is
recommended.

These functions cannot return
KEY_
values as there
is no way to distinguish a
KEY_
value from a valid
wchar_t
value.

The header file
<curses.h>
automatically
includes the header file
<stdio.h>.

Note that all routines except
wgetn_wstr
may be macros.

RETURN VALUES

All these functions return
OK
upon successful
completion. Otherwise, they return
ERR.