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

RETURN VALUE

49       All functions return the integer ERR upon failure and OK on success.
50
51       X/Open does not define any error conditions.  This  implementation  re‐
52       turns an error if the window pointer is null.
53
54       Functions  with  a  "mv"  prefix  first perform a cursor movement using
55       wmove, and return an error if the position is outside the window, or if
56       the window pointer is null.
57

NOTES

59       All functions except wadd_wchnstr may be macros.
60

PORTABILITY

62       These entry points are described in the XSI Curses standard, Issue 4.
63

SEE ALSO

65       curs_addwstr(3X), curses(3X).
66
67       Comparable  functions in the narrow-character (ncurses) library are de‐
68       scribed in curs_addchstr(3X).
69
70
71
72                                                           curs_add_wchstr(3X)
Impressum