.TH curs_getstr 3X "" .SH NAME \fBgetstr\fR, \fBwgetstr\fR, \fBmvgetstr\fR, \fBmvwgetstr\fR, \fBwgetnstr\fR - accept character strings from \fBcurses\fR terminal keyboard .SH SYNOPSIS \fB#include <curses.h>\fR \fBint getstr(char *str);\fR .br \fBint wgetstr(WINDOW *win, char *str);\fR .br \fBint mvgetstr(int y, int x, char *str);\fR .br \fBint mvwgetstr(WINDOW *win, int y, int x, char *str);\fR .br \fBint wgetnstr(WINDOW *win, char *str, int n);\fR .br .SH DESCRIPTION The function \fBgetstr\fR is equivalent to a series of calls to \fBgetch\fR, until a newline or carriage return is received (the terminating character is not included in the returned string). The resulting value is placed in the area pointed to by the character pointer \fIstr\fR. \fBwgetnstr\fR reads at most \fIn\fR characters, thus preventing a possible overflow of the input buffer. Any attempt to enter more characters (other than the terminating newline or carriage return) causes a beep. Function keys also cause a beep and are ignored. The user's erase and kill characters are interpreted. If keypad mode is on for the window, \fBKEY_LEFT\fR and \fBKEY_BACKSPACE\fR are both considered equivalent to the user's kill character. Characters input are echoed only if \fBecho\fR is currently on. In that case, backspace is echoed as deletion of the previous character (typically a left motion). .SH RETURN VALUE All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful completion. .SH NOTES Note that \fBgetstr\fR, \fBmvgetstr\fR, and \fBmvwgetstr\fR may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. They read single-byte characters only. The standard specifies that they return \fBERR\fR on failure, but the single error condition \fBEOVERFLOW\fR associated with extended-level conformance is not yet returned (the XSI curses support for multi-byte characters is not yet present). SVr3 and early SVr4 curses implementations did not reject function keys; the SVr4.0 documentation claimed that "special keys" (such as function keys, "home" key, "clear" key, \fIetc\fR.) are interpreted" without giving details. It lied. In fact, the `character' value appended to the string by those implementations was predictable but not useful (being, in fact, the low-order eight bits of the key's KEY_ value). The functions \fBgetnstr\fR, \fBmvgetnstr\fR, and \fBmvwgetnstr\fR were present but not documented in SVr4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_getch\fR(3X). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: .\"# mode:nroff .\"# fill-column:79 .\"# End: