curs_inch.3x man page

inch, winch, mvinch, mvwinch — get a character and attributes from a curses window


#include <curses.h>

chtype inch(void);
chtype winch(WINDOW *win);
chtype mvinch(int y, int x);
chtype mvwinch(WINDOW *win, int y, int x);


These routines return the character, of type chtype, at the current position in the named window. If any attributes are set for that position, their values are OR'ed into the value returned. Constants defined in <curses.h> can be used with the & (logical AND) operator to extract the character or attributes alone.


The following bit-masks may be AND-ed with characters returned by winch.

A_CHARTEXTBit-mask to extract character
A_ATTRIBUTESBit-mask to extract attributes
A_COLORBit-mask to extract color-pair field information

Return Value

Functions with a "mv" prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null.


Note that all of these routines may be macros.


These functions are described in the XSI Curses standard, Issue 4.

See Also


Comparable functions in the wide-character (ncursesw) library are described in curs_in_wch(3X).