curs_addwstr(3x) — Linux manual page

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

curs_addwstr(3X)              Library calls              curs_addwstr(3X)

NAME         top

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

SYNOPSIS         top

       #include <curses.h>

       int addwstr(const wchar_t * wstr);
       int waddwstr(WINDOW * win, const wchar_t * wstr);
       int mvaddwstr(int y, int x, const wchar_t * wstr);
       int mvwaddwstr(WINDOW * win, int y, int x,
             const wchar_t * wstr);

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

DESCRIPTION         top

       waddwstr writes the characters of the (wide-null-terminated) wide-
       character string wstr to the window win, as if by constructing a
       cchar_t for each wchar_t in wstr, then calling wadd_wch(3X) with
       the resulting cchar_t.  curses processes spacing and non-spacing
       characters in wstr one at a time.  waddnwstr is similar, but
       writes at most n wide characters.  If n is -1, waddnwstr writes
       the entire wide string.  ncurses(3X) describes the variants of
       these functions.

RETURN VALUE         top

       These functions return OK on success and ERR on failure.

       In ncurses, these functions fail if

       •   the curses screen has not been initialized,

       •   wstr is a null pointer,

       •   (for functions taking a WINDOW pointer argument) win is a null
           pointer, or

       •   an internal wadd_wch(3X) call returns ERR.

       Functions prefixed with “mv” first perform cursor movement and
       fail if the position (y, x) is outside the window boundaries.

NOTES         top

       All of these functions except waddnwstr may be implemented as
       macros.

PORTABILITY         top

       X/Open Curses Issue 4 describes these functions.

       SVr4 describes a successful return value only as “an integer value
       other than ERR”.

HISTORY         top

       X/Open Curses Issue 4 (1995) initially specified these functions.
       The System V Interface Definition Version 4 of the same year
       specified functions named waddwstr and waddnwstr (and the usual
       variants).  These were later additions to SVr4.x, not appearing in
       the first SVr4 (1989).

SEE ALSO         top

       curs_addstr(3X) describes comparable functions of the ncurses
       library in its non-wide-character configuration.

       curses(3X), curs_add_wch(3X), curs_add_wchstr(3X)

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://invisible-island.net/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to bug-ncurses@gnu.org.
       This page was obtained from the tarball ncurses-6.6.tar.gz fetched
       from ⟨https://ftp.gnu.org/gnu/ncurses/⟩ on 2026-01-16.  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

ncurses @NCURSES_MAJOR@.@NCU... 2025-03-15               curs_addwstr(3X)