1curs_add_wchstr(3X)                                        curs_add_wchstr(3X)
2
3
4

NAME

6       add_wchstr,   add_wchnstr,   wadd_wchstr,  wadd_wchnstr,  mvadd_wchstr,
7       mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add an array of  complex
8       characters (and attributes) to a curses window
9

SYNOPSIS

11       #include <curses.h>
12
13       int add_wchstr(const cchar_t *wchstr);
14       int add_wchnstr(const cchar_t *wchstr, int n);
15       int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
16       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
17       int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
18       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
19       int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
20       int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);
21

DESCRIPTION

23       These  routines  copy  the  array of complex characters wchstr into the
24       window image structure at and after the current cursor  position.   The
25       four  routines with n as the last argument copy at most n elements, but
26       no more than will fit on the line.  If n=-1 then  the  whole  array  is
27       copied, to the maximum number of characters that will fit on the line.
28
29       The  window  cursor  is  not advanced.  These routines work faster than
30       waddnstr.  On the other hand, they do not perform checking (such as for
31       the  newline,  backspace,  or  carriage return characters), they do not
32       advance the current cursor position, they do not expand  other  control
33       characters to ^-escapes, and they truncate the string if it crosses the
34       right margin, rather than wrapping it around to the new line.
35
36       These routines end successfully on encountering a null cchar_t, or when
37       they  have filled the current line.  If a complex character cannot com‐
38       pletely fit at the end of the current line, the remaining  columns  are
39       filled with the background character and rendition.
40

NOTES

42       All functions except wadd_wchnstr may be macros.
43

RETURN VALUES

45       All routines return the integer ERR upon failure and OK on success.
46

PORTABILITY

48       All  these entry points are described in the XSI Curses standard, Issue
49       4.
50

SEE ALSO

52       curses(3X), curs_addchstr(3X), curs_addwstr(3X)
53
54
55
56                                                           curs_add_wchstr(3X)
Impressum