.TH curs_inchstr 3X "" .SH NAME \fBinchstr\fR, \fBinchnstr\fR, \fBwinchstr\fR, \fBwinchnstr\fR, \fBmvinchstr\fR, \fBmvinchnstr\fR, \fBmvwinchstr\fR, \fBmvwinchnstr\fR - get a string of characters (and attributes) from a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR \fBint inchstr(chtype *chstr);\fR .br \fBint inchnstr(chtype *chstr, int n);\fR .br \fBint winchstr(WINDOW *win, chtype *chstr);\fR .br \fBint winchnstr(WINDOW *win, chtype *chstr, int n);\fR .br \fBint mvinchstr(int y, int x, chtype *chstr);\fR .br \fBint mvinchnstr(int y, int x, chtype *chstr, int n);\fR .br \fBint mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);\fR .br \fBint mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);\fR .br .SH DESCRIPTION These routines return a NULL-terminated array of \fBchtype\fR quantities, starting at the current cursor position in the named window and ending at the right margin of the window. The four functions with \fIn\fR as the last argument, return a leading substring at most \fIn\fR characters long (exclusive of the trailing (chtype)0). Constants defined in \fB<curses.h>\fR can be used with the \fB&\fR (logical AND) operator to extract the character or the attribute alone from any position in the \fIchstr\fR [see curs_inch(3X)]. .SH RETURN VALUE All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion (the number of characters retrieved, exclusive of the trailing 0). .SH NOTES Note that all routines except \fBwinchnstr\fR may be macros. SVr4 does not document whether the result string is 0-terminated; it does not document whether a length limit argument includes any trailing 0; and it does not document the meaning of the return value. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. It is no more specific than the SVr4 documentation on the trailing 0. It does specify that the successful return of the functions is \fBOK\fR. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inch\fR(3X). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: .\"# mode:nroff .\"# fill-column:79 .\"# End: