curs_addchstr(3X)curs_addchstr(3X)NAME
addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, mvaddchnstr,
mvwaddchstr, mvwaddchnstr - add a string of characters (and attributes)
to a curses window
SYNOPSIS
#include <curses.h>
int addchstr(const chtype *chstr);
int addchnstr(const chtype *chstr, int n);
int waddchstr(WINDOW *win, const chtype *chstr);
int waddchnstr(WINDOW *win, 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);
DESCRIPTION
These routines copy chstr into the window image structure at and after
the current cursor position. The four routines with n as the last ar‐
gument copy at most n elements, but no more than will fit on the line.
If n=-1 then the whole string is copied, to the maximum number of char‐
acters that will fit on the line.
The window cursor is not advanced, and these routines work faster than
waddnstr. On the other hand, they do not perform any kind of checking
(such as for the newline, backspace, or carriage return characters),
they do not advance the current cursor position, they do not expand
other control characters to ^-escapes, and they truncate the string if
it crosses the right margin, rather than wrapping it around to the new
line.
RETURN VALUES
All routines return the integer ERR upon failure and OK on success (the
SVr4 manuals specify only "an integer value other than ERR") upon suc‐
cessful completion, unless otherwise noted in the preceding routine de‐
scriptions.
X/Open does not define any error conditions. This implementation re‐
turns an error if the window pointer is null.
Functions with a "mv" prefix first perform a cursor movement using
wmove, and return an error if the position is outside the window, or if
the window pointer is null.
NOTES
Note that all routines except waddchnstr may be macros.
PORTABILITY
These entry points are described in the XSI Curses standard, Issue 4.
SEE ALSOcurses(3X).
Comparable functions in the wide-character (ncursesw) library are de‐
scribed in curs_add_wchstr(3X).
curs_addchstr(3X)
