***************************************************************************
Copyright 2018-2023,2024 Thomas E. Dickey *
Copyright 2002-2010,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_in_wch.3x,v 1.31 2024/04/20 21:20:07 tom Exp $
.\} .\} \%in_wch, \%mvin_wch, \%mvwin_wch, \%win_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);

These functions extract the complex character and rendition from the current position in the named window into the cchar_t object referenced by wch. No errors are defined in X/Open Curses. 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.

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. These functions are described in X/Open Curses, Issue 4. \%curs_inch(3X) describes comparable functions of the \%ncurses library in its non-wide-character configuration.

\%curses(3X), \%curs_inwstr(3X)