curs_inchstr(3) UNIX Programmer's Manual curs_inchstr(3)
inchstr, inchnstr, winchstr, winchnstr, mvinchstr,
mvinchnstr, mvwinchstr, mvwinchnstr - get a string of
characters (and attributes) from a curses window
#include <curses.h>
int inchstr(chtype *chstr);
int inchnstr(chtype *chstr, int n);
int winchstr(WINDOW *win, chtype *chstr);
int winchnstr(WINDOW *win, chtype *chstr, int n);
int mvinchstr(int y, int x, chtype *chstr);
int mvinchnstr(int y, int x, chtype *chstr, int n);
int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr,
int n);
These routines return a NULL-terminated array of chtype
quantities, starting at the current cursor position in the
named window and ending at the right margin of the window.
The four functions with n as the last argument, return a
leading substring at most n characters long (exclusive of
the trailing (chtype)0). Constants defined in <curses.h> can
be used with the & (logical AND) operator to extract the
character or the attribute alone from any position in the
chstr [see curs_inch(3)].
All routines return the integer ERR upon failure and an in-
teger value other than ERR upon successful completion (the
number of characters retrieved, exclusive of the trailing
0).
No error conditions are defined. If the chstr parameter is
null, no data is returned, and the return value is zero.
Note that all routines except winchnstr may be macros. SVr4
does not document whether the result string is 0-terminated;
it does not document whether a length limit argument in-
cludes any trailing 0; and it does not document the meaning
of the return value.
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 re-
turn of the functions is OK.
MirOS BSD #10-current Printed 19.2.2012 1
curs_inchstr(3) UNIX Programmer's Manual curs_inchstr(3)
curses(3), curs_inch(3).
MirOS BSD #10-current Printed 19.2.2012 2
Generated on 2012-02-20 02:47:02 by $MirOS: src/scripts/roff2htm,v 1.70 2011/12/03 18:21:12 tg Exp $
These manual pages and other documentation are copyrighted by their respective writers;
their source is available at our CVSweb,
AnonCVS, and other mirrors. The rest is Copyright © 2002‒2011 The MirOS Project, Germany.
This product includes material
provided by Thorsten Glaser.
This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.