waddnwstr3x
Add a wide-character string to a curses window and advance the cursor
Part of curs_addwstr(3x).
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
- •
-
thecurses 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”.