carta
mvwaddnstr(3ncurses)

mvwaddnstr3ncurses

Add a string to a curses window and advance the cursor

Part of addstr(3ncurses).

Usage

int n);

Overview

waddstr writes the characters of the (null-terminated) string str to the window win, as if by calling waddch(3NCURSES) for each char in str. waddnstr is similar, but writes at most n characters. If n is -1, waddnstr writes the entire 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,

•

str is NULL, or

•

an internal waddch(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 waddnstr may be implemented as macros.

Portability

X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.

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)
  • Debian 3.0 (Woody)

History

4BSD (1980) introduced waddstr along with its variants, the latter defined as macros.

SVr3.1 (1987) added waddnstr (and its variants) redefining waddstr as a macro wrapping it.

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