curs_in_wch.3x - Man Page

#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);

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.

These functions return OK on success and ERR on failure.

In ncurses, win_wch returns 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.

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.

X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them.

curs_inch(3X) describes comparable functions of the ncurses library in its non-wide-character configuration.

curses(3X), curs_inwstr(3X)

The man pages in_wch.3x(3), mvin_wch.3x(3), mvwin_wch.3x(3) and win_wch.3x(3) are aliases of curs_in_wch.3x(3).