curs_addchstr(3x) — Linux manual page
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 functions copy the (null-terminated) chstr array into the
window image structure starting at the current cursor position.
The four functions with n as the last argument copy at most n el‐
ements, 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:
• they do not perform checking (such as for the newline, back‐
space, 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 VALUE
All functions return the integer ERR upon failure and OK on suc‐
cess.
X/Open does not define any error conditions. This implementation
returns an error if the window pointer is null.
Functions with a “mv” prefix first perform a cursor movement us‐
ing wmove, and return an error if the position is outside the
window, or if the window pointer is null.
NOTES
All functions except waddchnstr may be macros.
PORTABILITY
These entry points are described in the XSI Curses standard, Is‐
sue 4.
SEE ALSO
curses(3X), curs_addstr(3X).
Comparable functions in the wide-character (ncursesw) library are
described in curs_add_wchstr(3X).
COLOPHON
This page is part of the ncurses (new curses) project. Informa‐
tion about the project can be found at
⟨https://www.gnu.org/software/ncurses/ncurses.html⟩. If you have
a bug report for this manual page, send it to
bug-ncurses-request@gnu.org. This page was obtained from the
project's upstream Git mirror of the CVS repository
⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14. (At that
time, the date of the most recent commit that was found in the
repository was 2023-03-12.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
man-pages@man7.org