curs_add_wchstr(3x) Library calls curs_add_wchstr(3x)
add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr,
mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add a curses complex
character string to a window
#include <curses.h>
int add_wchstr(const cchar_t *wchstr);
int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
int add_wchnstr(const cchar_t *wchstr, int n);
int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);
wadd_wchstr copies the string of complex characters wchstr to the
window win. A null complex character terminates the string. If a
complex character does completely fit at the end of the line, curses
fills the remaining columns with the window background; see bkgrnd(3x).
wadd_wchnstr does the same, but copies at most n characters, or as many
as possible if n is -1. ncurses(3x) describes the variants of these
functions.
Because these functions do not call wadd_wch(3x) internally, they are
faster than waddwstr(3x) and waddnwstr(3x). On the other hand, they
o do not treat the backspace, carriage return, or line feed
characters specially;
o do not represent unprintable characters with wunctrl(3x);
o do not update the cursor position to follow the last character
written;
o truncate the string at the window's right margin, rather than
wrapping it to the next line and potentially scrolling.
These functions return OK on success and ERR on failure.
X/Open Curses does not specify any error conditions. ncurses returns
ERR if
o win is NULL or
o wchstr is NULL.
Functions prefixed with "mv" first perform cursor movement and fail if
the position (y, x) is outside the window boundaries.
All of these functions except wadd_wchnstr may be implemented as
macros.
X/Open Curses, Issue 4 describes these functions.
curs_addchstr(3x) describes comparable functions of the ncurses library
in its non-wide-character configuration.
curses(3x), curs_addwstr(3x), curs_add_wch(3x)
ncurses 6.5 2024-05-11 curs_add_wchstr(3x)