Curses Library Functions cursinchstr(3CURSES)
NAME
cursinchstr, inchstr, inchnstr, winchstr, winchnstr,
mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr - get a
string of characters (and attributes) from a curses window
SYNOPSIS
cc [ flag ... ] file ... -lcurses [ library ... ]
#include
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);
DESCRIPTION
With these routines, a string of type chtype, starting at
the current cursor position in the named window and ending
at the right margin of the window, is returned. The four
functions with n as the last argument, return the string at
most n characters long. Constants defined in can
be used with the & (logical AND) operator to extract the
character or the attribute alone from any position in the
chstr (see cursinch(3CURSES)).
RETURN VALUES
All routines return the integer ER upon failure and an
integer value other than ER upon successful completion.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 31 Dec 1996 1
Curses Library Functions cursinchstr(3CURSES)
ATRIBUTE TYPE ATRIBUTE VALUE
MT-Level Unsafe
SEE ALSO
cursinch(3CURSES), curses(3CURSES), attributes(5)
NOTES
The header automatically includes the headers
and .
Note that all routines except winchnstr() may be macros.
SunOS 5.11 Last change: 31 Dec 1996 2
|