CURS_GETSTR(3X-SVR4)RISC/os Reference Manual CURS_GETSTR(3X-SVR4)
NAME
curs_getstr: getstr, getnstr, wgetstr, mvgetstr, mvgetnstr,
mvwgetstr, mvwgetnstr, wgetnstr - get character strings
from curses terminal keyboard
SYNOPSIS
#include <curses.h>
int getstr(char *str);
int getnstr(char *str, int n);
int wgetstr(WINDOW *win, char *str);
int mvgetstr(int y, int x, char *str);
int mvgetnstr(int y, int x, char *str, int n);
int mvwgetstr(WINDOW *win, int y, int x, char *str);
int mvwgetnstr(WINDOW *win, int y, int x, char *str, int n);
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 while getstr, mvgetstr, and mvwgetstr may be mac-
ros, wgetnstr is not.
SEE ALSO
curses(3X), curs_getch(3X).
Printed 11/19/92 Page 1