curs_getstr(3X) curs_getstr(3X)
NAME
cursgetstr: getstr, wgetstr, mvgetstr, mvwgetstr, wgetnstr - get
character strings from curses terminal keyboard
SYNOPSIS
#include <curses.h>
int getstr(char *str);
int wgetstr(WINDOW *win, char *str);
int mvgetstr(int y, int x, char *str);
int mvwgetstr(WINDOW *win, int y, int x, char *str);
int wgetnstr(WINDOW *win, char *str, int n);
DESCRIPTION
The effect of getstr is as though a series of calls to getch were
made, until a newline and carriage return is received. The resulting
value is placed in the area pointed to by the character pointer str.
wgetnstr reads at most n 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, etc.).
RETURN VALUE
All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.
NOTES
The header file <curses.h> automatically includes the header files
<stdio.h> and <unctrl.h>.
Note that getstr, mvgetstr, and mvwgetstr may be macros.
SEE ALSO
curses(3X), cursgetch(3X).
7/91 Page 1