inchnstr(3curses)

inchnstr -- input an array of single-byte characters and renditions from a window

Synopsis

cc [options] file -lcurses

#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 specified window into the array pointed to by chstr, starting at the current or specified position and ending at the end of the line.

The inchnstr(3curses), mvinchnstr(3curses), mvwinchnstr(3curses) and winchnstr(3curses) functions store at most n elements from the current or specified 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 defined.

Usage

Reading a line that overflows the array pointed to by chstr with inchstr(3curses), mvinchstr(3curses), mvwinchstr(3curses) or winchstr(3curses) causes undefined results. The use of inchnstr(3curses), mvinchnstr(3curses), mvwinchnstr(3curses) or winchnstr(3curses), respectively, is recommended.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

inch(3curses), curses(4)