manpagez: man pages & more
man curs_add_wchstr(3)
Home | html | info | man
curs_add_wchstr(3)              Library calls             curs_add_wchstr(3)


NAME

       add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr,
       mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add a curses complex
       character string to a window


SYNOPSIS

       #include <curses.h>

       int add_wchstr(const cchar_t *wchstr);
       int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
       int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
       int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);

       int add_wchnstr(const cchar_t *wchstr, int n);
       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
       int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);


DESCRIPTION

       These functions copy the (null-terminated) array of complex characters
       wchstr into the window image structure starting at the current cursor
       position.

       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 of characters that will fit on the line.

       The window cursor is not advanced.  These functions are 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 ^-escapes, and

       o   they truncate the string if it crosses the right margin, 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 Curses does not specify any error conditions.  This
       implementation returns an error

       o   if the win parameter is null or

       o   if the wchstr parameter is null.

       Functions prefixed with "mv" first perform cursor movement and fail if
       the position (y, x) is outside the window boundaries.


NOTES

       All functions except wadd_wchnstr may be macros.


PORTABILITY

       These functions are described in X/Open Curses, Issue 4.


SEE ALSO

       curs_addchstr(3X) describes comparable functions of the ncurses library
       in its non-wide-character configuration.

       curses(3X), curs_addwstr(3X), curs_add_wch(3X)

ncurses 6.5                       2024-04-20               curs_add_wchstr(3)

ncurses 6.5 - Generated Wed May 1 14:07:07 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.