- These functions extract the complex character and rendition from the
- current position in the named window into the cchar_t object referenced
- by wcval.
+ 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.
- No errors are defined in the XSI Curses standard. This implementation
- checks for null pointers, returns ERR in that case. Also, the mv
- routines check for error moving the cursor, returning ERR in that case.
- Otherwise they return OK.
+ These functions return OK on success and ERR on failure.
+
+ In ncurses, win_wch returns ERR if win is NULL.
- 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.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
- Note that all of these routines may be macros.
+ 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.
- These functions are described in the XSI Curses standard, Issue 4.
+ X/Open Curses, Issue 4 describes these functions. It specifies no
+ error conditions for them.