man pages section 3: Curses Library Functions

inchstr(3CURSES)

Name

curs_inchstr, 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 <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);

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 <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(3CURSES)).

Return Values

All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

curs_inch(3CURSES), curses(3CURSES), attributes(5)

Notes

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that all routines except winchnstr() may be macros.