curs_in_wchstr(3x) — Linux manual page


curs_in_wchstr(3X)                                        curs_in_wchstr(3X)

NAME         top

       in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr,
       mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an array of complex
       characters and renditions from a curses window

SYNOPSIS         top

       #include <curses.h>

       int in_wchstr(cchar_t *wchstr);
       int in_wchnstr(cchar_t *wchstr, int n);
       int win_wchstr(WINDOW *win, cchar_t *wchstr);
       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
       int mvin_wchstr(int y, int x, cchar_t *wchstr);
       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
       int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);

DESCRIPTION         top

       These functions return an array of complex characters in wchstr,
       starting at the current cursor position in the named window.
       Attributes (rendition) are stored with the characters.

       The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the
       array with at most n cchar_t elements.

NOTES         top

       Note that all routines except win_wchnstr may be macros.

       Reading a line that overflows the array pointed to by wchstr with
       in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined
       results.  Therefore, the use of in_wchnstr, mvin_wchnstr,
       mvwin_wchnstr, or win_wchnstr is recommended.

RETURN VALUE         top

       Upon successful completion, these functions return OK.  Otherwise,
       they return ERR.

       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.

PORTABILITY         top

       The XSI Curses defines no error conditions.  This implementation
       checks for null pointers, returning ERR in that case.

SEE ALSO         top

       Functions: curses(3X), curs_in_wch(3X), curs_instr(3X),
       curs_inwstr(3X) curs_inchstr(3X)

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a
       bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨git://⟩ on 2020-09-18.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-08-17.)  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