curs_addwchstr(S)

curs_addwchstr: addwchstr, addwchnstr, waddwchstr, waddwchnstr, mvaddwchstr, mvaddwchnstr, mvwaddwchstr, mvwaddwchnstr -- add string of wchar_t characters (and attributes) to a curses window

Syntax

cc ... -lcurses

#include <curses.h>

int addwchstr(chtype *wchstr);
int addwchnstr(chtype *wchstr, int n);
int waddwchstr(WINDOW *win, chtype *wchstr);
int waddwchnstr(WINDOW *win, chtype *wchstr, int n);
int mvaddwchstr(int y, int x, chtype *wchstr);
int mvaddwchnstr(int y, int x, chtype *wchstr, int n);
int mvwaddwchstr(WINDOW *win, int y, int x, chtype *wchstr);
int mvwaddwchnstr(WINDOW *win, int y, int x, chtype *wchstr, int n);

Description

All of these routines copy wchstr, which points to a string of wchar_t characters, directly into the window image structure starting at the current cursor position. The four routines with n as the last argument copy at most n elements, but no more than fit on the line. If n = -1 then the whole string is copied, to the maximum number that fit on the line. The window cursor does not advance.

These routines work faster than waddnwstr(S) because they merely copy wchstr into the window image structure. But you must be careful when using these functions because:

They don't do any checking (such as for the newline character).
They don't advance the current cursor position.
They truncate the string rather than wrapping it around to the new line.

Return values

All routines return the integer ERR on failure and an integer value other than ERR on successful completion, unless otherwise noted in the preceding routine descriptions.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

All routines except waddwchnstr(S) can be macros.

Files

/usr/lib/libcurses.a: the library

Standards conformance

addwchstr(S), addwchnstr(S), waddwchstr(S), waddwchnstr(S), mvaddwchstr(S), mvaddwchnstr(S), mvwaddwchstr(S), and mvwaddwchnstr(S) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.