NAME

       in_wchstr,  in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr -
       get a curses complex character string from a window

SYNOPSIS

       #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

       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  four  functions  with  n  as  the last argument return a leading substring at most n characters long
       (exclusive of the trailing zeroed cchar_t.  Transfer stops at the end of the  current  line,  or  when  n
       characters have been stored at the location referenced by wchstr.

       Constants defined in <curses.h> can be used with the & (logical AND) operator to extract the character or
       the attribute alone from any position in the wchstr [see getcchar(3NCURSES)].

RETURN VALUE

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

       X/Open Curses defines no error conditions.  This implementation returns an error

       •   if the win parameter is null or

       •   if the wchstr parameter 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.

NOTES

       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.

PORTABILITY

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

SEE ALSO

       ncurses(3NCURSES), inchstr(3NCURSES), instr(3NCURSES), inwstr(3NCURSES), in_wch(3NCURSES)

ncurses 6.4                                        2023-11-18                                in_wchstr(3NCURSES)