GETN_WSTR(3XCURSES) X/Open Curses Library Functions GETN_WSTR(3XCURSES)
NAME
getn_wstr, get_wstr, mvgetn_wstr, mvget_wstr, mvwgetn_wstr,
mvwget_wstr, wgetn_wstr, wget_wstr - get a wide character string from
terminal
SYNOPSIS
cc [
flag... ]
file...
-I /usr/xpg4/include
-L /usr/xpg4/lib \
-R /usr/xpg4/lib
-lcurses [
library... ]
c89 [
flag... ]
file...
-lcurses [
library... ]
#include <curses.h>
int getn_wstr(
wint_t *wstr,
int n);
int get_wstr(
wint_t *wstr);
int mvgetn_wstr(
int y,
int x,
wint_t *wstr,
int n);
int mvget_wstr(
int y,
int x,
wint_t *wstr);
int mvwgetn_wstr(
WINDOW *win,
int y,
int x,
wint_t *wstr,
int n);
int mvwget_wstr(
WINDOW *win,
int y,
int x,
wint_t *wstr);
int wgetn_wstr(
WINDOW *win,
wint_t *wstr,
int n);
int wget_wstr(
WINDOW *win,
wint_t *wstr);
DESCRIPTION
The
get_wstr() and
wget_wstr() functions get a wide character string
from the terminal associated with the window
stdscr or window
win,
respectively. The
mvget_str() and
mvwget_wstr() functions move the
cursor to the position specified in
stdscr or
win, respectively,
then get a wide character string.
These functions call
wget_wch(3XCURSES) and place each received
character in
wstr until a newline character, end-of-line character,
or end-of-file character is received, which is also placed in
wstr.
The erase and kill characters set by the user are processed.
The
getn_wstr(),
mvgetn_wstr(),
mvwgetn_wstr() and
wgetn_wstr() functions read at most
n characters. These functions are used to
prevent overflowing the input buffer.
PARAMETERS
wstr Is a pointer to the area where the character string is to be
placed.
n Is the maximum number of characters to read from input.
y Is the y (row) coordinate of starting position of character
string to be read.
x Is the x (column) coordinate of starting position of
character string to be read.
win points to the window associated with the terminal from which
the character is to be read.
RETURN VALUES
On success, these functions return
OK. Otherwise, they return
ERR.
ERRORS
None.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
get_wch(3XCURSES),
getnstr(3XCURSES),
libcurses(3XCURSES),
attributes(7),
standards(7) June 5, 2002 GETN_WSTR(3XCURSES)
