|
HTML rendering created 2026-01-16 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | HISTORY | SEE ALSO | COLOPHON |
|
|
|
curs_in_wch(3X) Library calls curs_in_wch(3X)
in_wch, win_wch, mvin_wch, mvwin_wch - get a curses complex
character from a window
#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, 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.
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.
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.
curs_inch(3X) describes comparable functions of the ncurses
library in its non-wide-character configuration.
curses(3X), curs_inwstr(3X)
This page is part of the ncurses (new curses) project.
Information about the project can be found at
⟨https://invisible-island.net/ncurses/ncurses.html⟩. If you have a
bug report for this manual page, send it to bug-ncurses@gnu.org.
This page was obtained from the tarball ncurses-6.6.tar.gz fetched
from ⟨https://ftp.gnu.org/gnu/ncurses/⟩ on 2026-01-16. If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for the
page, or you have corrections or improvements to the information
in this COLOPHON (which is not part of the original manual page),
send a mail to man-pages@man7.org
ncurses @NCURSES_MAJOR@.@NCU... 2025-02-01 curs_in_wch(3X)
|
HTML rendering created 2026-01-16 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|