HP 3000 Manuals HP 3000 Manuals
inchstr, winchstr, inchnstr, winchnstr, mvinchstr, mvwinchstr,
mvinchnstr, mvwinchnstr
The inchstr set of routines is used to return a character string (with
attributes).
Syntax
#include <curses.h>
int inchstr(chtype *chstr);
int winchstr(WINDOW *win, chtype *chstr);
int inchnstr(chtype *chstr, int n);
int winchnstr(WINDOW *win, chtype *chstr, int n);
int mvinchstr(int y, int x, chtype *chstr);
int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
int mvinchnstr(int y, int x, chtype *chstr, int n);
int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);
Parameters
n The number of characters not to exceed when
returning chstr.
chstr The character string to be returned.
win A pointer to the window in which the string is to
be returned.
x The x (column) coordinate of the starting position
of the string to be returned.
y The y (row) coordinate of the starting position of
the string to be returned.
Return Values
OK Successful completion.
ERR An error occurred.
Description
The inchstr() and winchstr() routines return the character string (with
attributes) starting at the current cursor position of the stdscr window
and window win, respectively, and ending at the right margin. The
mvinchstr() and mvwinchstr() routines return the character string located
at the position indicated by the x (column) and y (row) parameters (the
former in the stdscr window; the latter in window win).
The inchnstr(), winchnstr(), mvinchnstr(), and mvwinchnstr() routines
return at most n characters from the window stdscr and win, respectively.
The former two routines return the string, starting at the current cursor
position; the latter two commands return the string, starting at the
position specified by the x and y parameters.
The complete character/attribute pair is returned. The character or
attributes can be extracted by performing a bitwise AND on the returned
value, using the constants A_CHARTEXT, A_ATTRIBUTES, and A_COLOR defined
in curses.h. The character string can also be returned without
attributes by using winstr().
NOTE All routines except winchnstr() are macros.
Implementation Considerations
UNIX System V implementation
See Also
winch(), winstr()
Portability
UNIX System V