inchnstr.3x (2010 09)

inchnstr(3X) inchnstr(3X)

(ENHANCED CURSES)

NAME

inchnstr, inchstr, mvinchnstr, mvinchstr, mvwinchnstr, mvwinchstr, winchnstr, winchstr — input an

array of single-byte characters and renditions from a window

SYNOPSIS

#include <curses.h>

int inchnstr(chtype *chstr, int n);

int inchstr(chtype *chstr);

int mvinchnstr(int y, int x, chtype *chstr, int n);

int mvinchstr(int y, int x, chtype *chstr);

int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);

int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);

int winchnstr(WINDOW *win, chtype *chstr, int n);

int winchstr(WINDOW *win, chtype *chstr);

DESCRIPTION

These functions place characters and renditions from the current or speciﬁed window into the array

pointed to by chstr, starting at the current or speciﬁed position and ending at the end of the line.

The

inchnstr(), mvinchnstr(), mvwinchnstr()

and winchnstr() functions store at most n

elements from the current or speciﬁed window into the array pointed to by chstr.

RETURN VALUE

Upon successful completion, these functions return OK. Otherwise, they return ERR.

ERRORS

No errors are deﬁned.

APPLICATION USAGE

Reading a line that overﬂows the array pointed to by chstr with

inchstr(),

mvinchstr(),

mvwinchstr() or winchstr() causes undeﬁned results. The use of inchnstr(), mvinchnstr(),

mvwinchnstr() or winchnstr(), respectively, is recommended.