carta
mvwaddwstr(3ncurses)

mvwaddwstr3ncurses

Add a wide-character string to a curses window and advance the cursor

Part of addwstr(3ncurses).

Usage

const wchar_t * wstr);

Overview

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(3NCURSES) 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(3NCURSES) describes the variants of these functions.

Return value

These functions return OK on success and ERR on failure.

In ncurses, they return ERR if

•

win is NULL,

•

wstr is NULL, or

•

an internal wadd_wch(3NCURSES) call returns ERR.

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

Notes

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

Portability

X/Open Curses Issue 4 describes these functions.

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

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch) to Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze) to Debian 4.0 (Etch)
  • Debian 3.1 (Sarge)

History

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).

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.