carta
curs_addwstr(3)

curs_addwstr3

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

Part of addnwstr(3).

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(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

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

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

  • FreeBSD 16.0-CURRENT (2026-10-27) to FreeBSD 15.1-RELEASE: the text shown here
  • FreeBSD 15.0-RELEASE
  • FreeBSD 14.5-RELEASE
  • FreeBSD 14.4-RELEASE to FreeBSD 14.2-RELEASE
  • FreeBSD 14.1-RELEASE to FreeBSD 14.0-RELEASE
  • FreeBSD 13.5-RELEASE to FreeBSD 13.0-RELEASE
  • FreeBSD 12.4-RELEASE to FreeBSD 11.0-RELEASE
  • FreeBSD 10.4-RELEASE to FreeBSD 6.3-RELEASE

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 base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's man source.