in_wch, win_wch, mvin_wch, mvwin_wch - get a curses complex character from a window
Contents
Description
win_wch copies the curses complex character at the cursor position in win into wch. Use
getcchar(3NCURSES) to extract its character code, attributes, and color pair identifier.
ncurses(3NCURSES) describes the variants of this function.
History
X/Open Curses Issue 4 (1995) initially specified these functions. The System V Interface Definition
Version 4 of the same year specified a function named winwch (and the usual variants). This was a later
addition to SVr4.x, not appearing in the first SVr4 (1989). It differed from X/Open's later win_wch in
that it returned a value of type chtype instead of cchar_t.
Name
in_wch, win_wch, mvin_wch, mvwin_wch - get a curses complex character from a window
Notes
in_wch, mvin_wch, and mvwin_wch may be implemented as macros.
Unlike winch(3NCURSES), 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.
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.
See Also
inch(3NCURSES) describes comparable functions of the ncurses library in its non-wide-character configuration. ncurses(3NCURSES), inwstr(3NCURSES) ncurses 6.5 2025-02-01 in_wch(3NCURSES)
Synopsis
#include<curses.h>intin_wch(cchar_t*wch);intwin_wch(WINDOW*win,cchar_t*wch);intmvin_wch(inty,intx,cchar_t*wch);intmvwin_wch(WINDOW*win,inty,intx,cchar_t*wch);
