addchstr(3curses)

addchstr -- add string of single-byte characters and renditions to a window

Synopsis

cc [options] file -lcurses

#include <curses.h>

int addchstr(const chtype *chstr);

int addchnstr(const chtype *chstr, int n);

int mvaddchstr(int y, int x, const chtype *chstr);

int mvaddchnstr(int y, int x, const chtype *chstr, int n);

int mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);

int mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr,
                 int n);

int waddchstr(WINDOW *win, const chtype *chstr);

int waddchnstr(WINDOW *win, const chtype *chstr, int n);

Description

These functions overlay the contents of the current or specified window, starting at the current or specified position, with the contents of the array pointed to by chstr until a null chtype is encountered in the array pointed to by chstr.

These functions do not change the cursor position. These functions do not perform special-character processing. These functions do not perform wrapping.

The addchnstr(3curses), mvaddchnstr(3curses), mvwaddchnstr(3curses) and waddchnstr(3curses) functions copy at most n items, but no more than will fit on the current or specified line. If n is -1 then the whole string is copied, to the maximum number that fit on the current or specified line.

Return value

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

Errors

No errors are defined.

Usage

These functions are only guaranteed to operate reliably on character sets in which each character fits into a single byte, whose attributes can be expressed using only constants with the A_ prefix.

Standards Conformance

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

References

addch(3curses), add_wch(3curses), add_wchstr(3curses), curses(4)