curs_getwstr(S)

curs_getwstr: getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr, mvgetnwstr, mvwgetwstr, mvwgetnwstr -- get wchar_t character strings from curses terminal keyboard

Syntax

cc ... -lcurses

#include <curses.h>

int getwstr(wchar_t *wstr);
int getnwstr(wchar_t *wstr, int n);
int wgetwstr(WINDOW *win, wchar_t *wstr);
int wgetnwstr(WINDOW *win, wchar_t *wstr, int n);
int mvgetwstr(int y, int x, wchar_t *wstr);
int mvgetnwstr(int y, int x, wchar_t *wstr, int n);
int mvwgetwstr(WINDOW *win, int y, int x, wchar_t *wstr);
int mvwgetnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);

Description

The effect of getwstr(S) is as though a series of calls to getwch(S) were made, until a newline and carriage return is received. The resulting value is placed in the area pointed to by the wchar_t pointer str. getnwstr(S) reads at most n wchar_t characters, thus preventing a possible overflow of the input buffer. The user's erase and kill characters are interpreted, as well as any special keys (such as function keys, ``home'' key, ``clear'' key, and so on).

Return values

All routines return the integer ERR on failure and an integer value other than ERR on successful completion.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

All routines except wgetnwstr(S) can be macros.

Files

/usr/lib/libcurses.a: the library

Standards conformance

getwstr(S), getnwstr(S), wgetwstr(S), wgetnwstr(S), mvgetwstr(S), mvgetnwstr(S), mvwgetwstr(S), and mvwgetnwstr(S) are not part of any currently supported standard; they are extensions of AT&T System V developed by The Santa Cruz Operation, Inc. and maintained by The SCO Group.