curs_addstr.3x - Man Page

#include <curses.h>

int addstr(const char *str);
int mvaddstr(int y, int x, const char *str);
int mvwaddstr(WINDOW *win, int y, int x, const char *str);
int waddstr(WINDOW *win, const char *str);

int addnstr(const char *str, int n);
int mvaddnstr(int y, int x, const char *str, int n);
int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);
int waddnstr(WINDOW *win, const char *str, int n);

waddstr writes the characters of the (null-terminated) string str to the window win. Its process is similar to calling waddch(3X) for each char in str. Control characters are processed as in waddch(3X).

waddnstr writes at most n characters, or until a terminating null character occurs in str. If n is -1, waddnstr writes the entire string.

ncurses(3X) describes the variants of these functions.

These functions return OK on success and ERR on failure.

In ncurses, they return ERR if

• win is NULL,
• str is NULL, or
• an internal waddch(3X) call returns ERR.

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

All of these functions except waddnstr may be macros.

X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them.

4BSD (1980) curses introduced waddstr along with its variants, the latter defined as macros.

SVr3.1 (1987) added waddnstr (and its variants) redefining waddstr as a macro wrapping it.

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

curses(3X), curs_addch(3X), curs_addchstr(3X)

The man pages addnstr.3x(3), addstr.3x(3), mvaddnstr.3x(3), mvaddstr.3x(3), mvwaddnstr.3x(3), mvwaddstr.3x(3), waddnstr.3x(3) and waddstr.3x(3) are aliases of curs_addstr.3x(3).