curs_in_wch(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON

curs_in_wch(3X)                                          curs_in_wch(3X)

NAME         top

       in_wch, mvin_wch, mvwin_wch, win_wch - extract a complex
       character and rendition from a window

SYNOPSIS         top

       #include <curses.h>

       int in_wch(cchar_t *wcval);
       int win_wch(WINDOW *win, cchar_t *wcval);

       int mvin_wch(int y, int x, cchar_t *wcval);
       int mvwin_wch(WINDOW *win, int y, int x, cchar_t *wcval);

DESCRIPTION         top

       These functions extract the complex character and rendition from
       the current position in the named window into the cchar_t object
       referenced by wcval.

RETURN VALUE         top

       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.

       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.

NOTES         top

       Note that all of these routines may be macros.

PORTABILITY         top

       These functions are described in the XSI Curses standard, Issue
       4.

SEE ALSO         top

       curses(3X), curs_inch(3X).

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2021-04-01.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-03-28.)  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

                                                         curs_in_wch(3X)