add_wchnstr(3curses)

add_wchnstr -- add an array of complex characters and renditions to a window

Synopsis

cc [options] file -lcurses

#include <curses.h>

int add_wchnstr(const cchar_t *wchstr, int n);

int add_wchstr(const cchar_t *wchstr);

int wadd_wchnstr(WINDOW *win, const cchar_t *wchstr, int n);

int wadd_wchstr(WINDOW *win, const cchar_t *wchstr);

int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);

int mvadd_wchstr(int y, int x, const cchar_t *wchstr);

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

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

Description

These functions write the array of cchar_t specified by wchstr into the current or specified window starting at the current or specified cursor position.

These functions do not advance the cursor. The results are unspecified if wchstr contains any special characters.

The functions end successfully on encountering a null cchar_t. The 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.

The add_wchnstr(3curses), mvadd_wchnstr(3curses), mvwadd_wchnstr(3curses) and wadd_wchnstr(3curses) functions end successfully after writing n cchar_ts (or the entire array of cchar_ts, if n is -1).

Return value

Upon successful completion, these functions return OK. Otherwise, they return ERR.

Errors

No errors are defined.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

curses(4)