https://invisible-island.net/ncurses/man/


curs_addwstr 3x 2023-11-18 ncurses 6.4 Library calls

curs_addwstr(3x)                 Library calls                curs_addwstr(3x)




NAME

       addwstr,   addnwstr,   waddwstr,   waddnwstr,   mvaddwstr,  mvaddnwstr,
       mvwaddwstr, mvwaddnwstr - add  a  wide-character  string  to  a  curses
       window and advance the cursor


SYNOPSIS

       #include <curses.h>

       int addwstr(const wchar_t *wstr);
       int addnwstr(const wchar_t *wstr, int n);
       int waddwstr(WINDOW *win, const wchar_t *wstr);
       int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);

       int mvaddwstr(int y, int x, const wchar_t *wstr);
       int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
       int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr);
       int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);


DESCRIPTION

       These  functions  write the characters of the (null-terminated) wchar_t
       character  string  wstr  on  the  given  window.   It  is  similar   to
       constructing  a  cchar_t  for  each wchar_t in the string, then calling
       wadd_wch(3x) for the resulting cchar_t:

       o   spacing and non-spacing characters in the string are processed  one
           at a time, and

       o   control characters are processed as in waddch(3x).

       The  mv  functions  perform  cursor  movement  once, before writing any
       characters.  Thereafter, the cursor is advanced  as  a  side-effect  of
       writing to the window.

       The  four functions with n as the last argument write at most n wchar_t
       characters, or until a terminating null is reached.  If n is  -1,  then
       the entire string will be added.


RETURN VALUE

       All functions return the integer ERR upon failure and OK on success.

       X/Open  does  not  define  any  error  conditions.  This implementation
       returns an error

       o   if the window pointer is null or

       o   if the string pointer is null or

       o   if the corresponding calls to wadd_wch return an error.

       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 of these functions except waddnwstr may be macros.


PORTABILITY

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


SEE ALSO

       curses(3x),   curs_addch(3x),    curs_addchstr(3x),    curs_addstr(3x),
       curs_add_wch(3x), curs_add_wchstr(3x)



ncurses 6.4                       2023-11-18                  curs_addwstr(3x)