in_wch3
Get a curses complex character from a window
Part of curs_in_wch(3).
Usage
#include <curses.h>
int in_wch(cchar_t * wch); int win_wch(WINDOW * win, cchar_t * wch); int mvin_wch(int y, int x, cchar_t * wch); int mvwin_wch(WINDOW * win, int y, int x, cchar_t * wch);
Overview
win_wch copies the curses complex character at the cursor position in win into wch. Use getcchar(3X) to extract its character code, attributes, and color pair identifier. ncurses(3X) describes the variants of this function.
Return value
These functions return OK on success and ERR on failure.
In ncurses, they return ERR if win is NULL.
Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.
Notes
in_wch, mvin_wch, and mvwin_wch may be implemented as macros.
Unlike winch(3X), win_wch and its variants store the value of the retrieved character in an additional wch parameter instead of the return value.
Portability
X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.
Releases
46 releases since FreeBSD 6.3-RELEASE; the text changed 7 times.