47 lines
1.6 KiB
Groff
47 lines
1.6 KiB
Groff
|
.TH curs_inchstr 3X ""
|
||
|
|
.SH NAME
|
||
|
|
\fBcurs_inchstr\fR: \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
|
||
|
|
\fBncurses\fR window
|
||
|
|
.SH SYNOPSIS
|
||
|
|
\fB#include <ncurses.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.
|
||
|
|
Constants defined in \fB<ncurses.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.
|
||
|
|
.SH NOTES
|
||
|
|
Note that all routines except \fBwinchnstr\fR may be macros.
|
||
|
|
.SH SEE ALSO
|
||
|
|
\fBncurses\fR(3X), \fBcurs_inch\fR(3X).
|
||
|
|
.\"#
|
||
|
|
.\"# The following sets edit modes for GNU EMACS
|
||
|
|
.\"# Local Variables:
|
||
|
|
.\"# mode:nroff
|
||
|
|
.\"# fill-column:79
|
||
|
|
.\"# End:
|