curs_in_wchstr(3x) — Linux manual page

curs_in_wchstr(3X)                                    curs_in_wchstr(3X)

NAME

       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

       #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.  At‐
       tributes (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

       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 unde‐
       fined results.  Therefore, the use of  in_wchnstr,  mvin_wchnstr,
       mvwin_wchnstr, or win_wchnstr is recommended.

RETURN VALUE

       Upon  successful  completion,  these functions return OK.  Other‐
       wise, they return ERR.

       Functions with a “mv” prefix first perform a cursor movement  us‐
       ing  wmove,  and  return  an error if the position is outside the
       window, or if the window pointer is null.

PORTABILITY

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

SEE ALSO

       Functions: curses(3X), curs_in_wch(3X), curs_instr(3X), curs_inw‐
       str(3X) curs_inchstr(3X)

COLOPHON

       This  page is part of the ncurses (new curses) project.  Informa‐
       tion    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
       ⟨https://github.com/mirror/ncurses.git⟩  on 2024-06-14.  (At that
       time, the date of the most recent commit that was  found  in  the
       repository  was  2023-03-12.)   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_wchstr(3X)