curs_add_wchstr 3x

curs_add_wchstr(3x)                                 curs_add_wchstr(3x)

NAME

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

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);

DESCRIPTION

       These functions copy the (null-terminated) array  of  com-
       plex  characters  wchstr  into  the window image structure
       starting at the current cursor position.  The  four  func-
       tions 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 of characters
       that will fit on the line.

       The window cursor is not advanced.  These  functions  work
       faster than waddnstr.  On the other hand:

       o   they do not perform checking (such as for the newline,
           backspace, or carriage return characters),

       o   they do not advance the current cursor position,

       o   they do not expand other control characters  to  ^-es-
           capes, and

       o   they  truncate the string if it crosses the right mar-
           gin, rather than wrapping it around to the new line.

       These functions end successfully on  encountering  a  null
       cchar_t,  or when they have filled the current line.  If a
       complex character cannot completely fit at the end of  the
       current  line,  the  remaining columns are filled with the
       background character and rendition.

RETURN VALUE

       All functions return the integer ERR upon failure  and  OK
       on success.

       X/Open  does not define any error conditions.  This imple-
       mentation returns an error if the window pointer is null.

       Functions with a "mv" prefix first perform a cursor  move-
       ment  using  wmove, and return an error if the position is
       outside the window, or if the window pointer is null.

NOTES

       All functions except wadd_wchnstr may be macros.

PORTABILITY

       These entry points are described in the XSI  Curses  stan-
       dard, Issue 4.

SEE ALSO

       curs_addwstr(3x), curses(3x).

       Comparable functions in the narrow-character (ncurses) li-
       brary are described in curs_addchstr(3x).



                                                    curs_add_wchstr(3x)