*** UNIX MANUAL PAGE BROWSER ***

curs_add_wchstr(3) Library Functions Manual curs_add_wchstr(3) NAME curs_add_wchstr, add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr, mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - Add an ar- ray of complex characters and rendition to a Curses window LIBRARY Curses Library (libcurses.a, libcurses.so) SYNOPSIS #include <curses.h> int add_wchstr(const cchar_t *wchstr); int add_wchnstr(const cchar_t *wchstr, int n); int wadd_wchstr(WINDOW *win, const cchar_t *wchstr); int wadd_wchnstr(WINDOW *win, const cchar_t *wchstr, int n); int mvadd_wchstr(int y, int x, const cchar_t *wchstr); int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n); int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr); int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n); STANDARDS Interfaces documented on this reference page conform to industry stan- dards as follows: add_wchstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr, mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr: XPG4-UNIX Refer to the standards(5) reference page for more information about in- dustry standards and associated tags. DESCRIPTION All of these functions copy wchstr, which points to an array of complex characters, directly into the current or specified window image struc- ture starting at the current cursor position or the position specified. The four functions with n as the last argument copy at most n elements, but no more than will fit on the line. If n=-1, then the whole array is copied, to the maximum number that fit on the line. The position of the window cursor is not advanced. These functions work faster than add_wstr because they merely copy wchstr into the win- dow image structure. On the other hand, care must be taken when using these functions because they do not perform any kind of checking for special characters (such as for the newline character), they do not ad- vance the current cursor position, and they truncate characters rather then wrapping them to the new line. These functions end successfully on encountering a null cchar_t. These functions also end successfully when they fill the current line. If a character cannot completely fit at the end of the current line, those columns are filled with the background character and rendition. NOTES The header file curses.h automatically includes the header file stdio.h. Note that all functions except wadd_wchnstr may be macros. RETURN VALUES All functions return the integer OK upon successful completion. Other- wise, they return ERR. RELATED INFORMATION Functions: curses(3), curs_addwstr(3) Others: standards(5) delim off curs_add_wchstr(3)