curs_inchstr(S-osr5)

curs_inchstr: inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr -- get a string of characters (and attributes) from a curses window

Syntax

cc ... -lcurses

#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

These routines return a string of type chtype, starting at the current cursor position in the specified window and ending at the right margin of the window. 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(S-osr5)).

Return values

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

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

All routines except winchnstr(S-osr5) can be macros.

Files

/usr/lib/libcurses.a: the library

Standards conformance

inchstr(S-osr5), inchnstr(S-osr5), winchstr(S-osr5), winchnstr(S-osr5), mvinchstr(S-osr5), mvinchnstr(S-osr5), mvwinchstr(S-osr5), and mvwinchnstr(S-osr5) are not part of any currently supported standard; they are extensions of AT&T System V developed by The Santa Cruz Operation, Inc. and maintained by The SCO Group.