get_wstr, getn_wstr, wget_wstr, wgetn_wstr, mvget_wstr, mvgetn_wstr, mvwget_wstr, mvwgetn_wstr − get an array of wide characters from a curses terminal keyboard


#include <ncurses/curses.h>

int get_wstr(wint_t *wstr);
int getn_wstr(wint_t *
wstr, int n);
int wget_wstr(WINDOW *
win, wint_t *wstr);
int wgetn_wstr(WINDOW *
win, wint_t *wstr, int n);
int mvget_wstr(int
y, int x, wint_t *wstr);
int mvgetn_wstr(int
y, int x, wint_t *wstr, int n);
int mvwget_wstr(WINDOW *
win, int y, int x, wint_t *wstr);
int mvwgetn_wstr(WINDOW *
win, int y, int x, wint_t *wstr, int n);


The effect of get_wstr is as though a series of calls to get_wch were made, until a newline, other end-of-line, or end-of-file condition is processed. An end-of-file condition is represented by WEOF, as defined in <wchar.h>. The newline and end-of-line conditions are represented by the \n 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 user’s erase and kill characters are interpreted. If keypad mode is on for the window, KEY_LEFT and KEY_BACKSPACE are both considered equivalent to the user’s kill character.

Characters input are echoed only if echo is currently on. In that case, backspace is echoed as deletion of the previous character (typically a left motion).

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.


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 because there is no way to distinguish a KEY_ value from a valid wchar_t value.

All of these routines except wgetn_wstr may be macros.


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

Functions using a window parameter return an error if it is null.


returns an error if the associated call to wget_wch failed.

Functions with a "mv" prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null.


These functions are described in The Single Unix Specification, Version 2. No error conditions are defined. This implementation returns ERR if the window pointer is null, or if the lower-level wget_wch 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 array contains a WEOF followed by a null wchar_t.

X/Open curses documents these functions to pass an array of wchar_t, but all of the vendors implement this using wint_t.


Functions: ncurses(3NCURSES), get_wch(3NCURSES), getstr(3NCURSES).

More Linux Commands

Mail::SpamAssassin::Message::Metadata(3pm) - extract metadat
This class is tasked with extracting metadata from messages for use as Bayes tokens, fodder for eval tests, or other rules. Metadata is supplemental data inferr

item_opts_off(3menu) - set and get menu item options........
The function set_item_opts sets all the given items option bits (menu option bits may be logically-ORed together). The function item_opts_on turns on the given

yes(1) - output a string repeatedly until killed (Man Page)
Repeatedly output a line with all specified STRING(s), or y. --help display this help and exit --version output version information and exit GNU coreutils onlin

gnutls_x509_crl_get_issuer_dn_by_oid(3) - API function......
This function will extract the part of the name of the CRL issuer specified by the given OID. The output will be encoded as described in RFC2253. The output str

place(n) - Geometry manager for fixed or rubber-sheet placem
The placer is a geometry manager for Tk. It provides simple fixed placement of windows, where you specify the exact size and location of one window, called the

rindex(3) - locate character in string - Linux manual page
The index() function returns a pointer to the first occurrence of the character c in the string s. The rindex() function returns a pointer to the last occurrenc

ppmdcfont(1) - Turn a Ppmdfont file into C source for a buil
This program is part of Netpbm(1) (There are no arguments or options) ppmdcfont creates a C source file that you can compile into a built-in font for use with t

Tcl_UniCharIsPrint(3) - routines for classification of Tcl_U
All of the routines described examine Tcl_UniChars and return a boolean value. A non-zero return value means that the character does belong to the character cla

pickup(8) - Postfix local mail pickup - Linux manual page...
The pickup(8) daemon waits for hints that new mail has been dropped into the maildrop directory, and feeds it into the cleanup(8) daemon. Ill-formatted files ar

stat(1) - display file or file system status (Man Page).....
Display file or file system status. Mandatory arguments to long options are mandatory for short options too. -L, --dereference follow links -f, --file-system di

XDeviceTimeCoord(3) - get device motion history (Man Page)
The server may retain the recent history of the device motion and do so to a finer granularity than is reported by DeviceMotionNotify events. The XGetDeviceMoti

glutSetKeyRepeat(3) - retrieves simple GLUT state represente
XXX fix me SEE ALSO glutIgnoreKeyRepeat, glutKeyboardFunc, glutSpecialFunc, glutKeyboardUpFunc, glutSpecialUpFunc, glutDeviceGet AUTHOR Mark J. Kilgard (mjk@nvi

We can't live, work or learn in freedom unless the software we use is free.