CURSES_ADDCHSTR(3) | Library Functions Manual | CURSES_ADDCHSTR(3)

# NAME

curses_addchstr, addchstr, waddchstr, addchnstr, waddchnstr, mvaddchstr, mvwaddchstr, mvaddchnstr, mvwaddchnstr — curses add character strings to windows routines

# LIBRARY

Curses Library (libcurses, -lcurses)

# SYNOPSIS

#include <curses.h>

int
addchstr(const chtype *chstr);

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

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

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

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

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

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

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

# DESCRIPTION

These functions add character strings and attributes to stdscr or to the specified window.

The addchstr() function will add the characters and their attributes passed in chstr to stdscr starting at the current cursor position. Any character attributes set in chstr will be merged with the background attributes currently set on stdscr. The waddstr() function does the same as addchstr() but adds the string to the window specified by win().

The addchnstr() function will add the contents of string to stdscr but will limit the number of characters added to be, at most, n. If n is -1 then addchnstr will add the number of characters contained in the null terminated string chstr. Any character attributes set in chstr will be merged with the background attributes currently set on stdscr.

The waddchnstr() function does the same as addchnstr but adds the string to the window specified by win.

The functions mvaddchstr(), mwaddchnstr(), mvwaddchstr() and mvwaddchnstr() are the same as the functions addchstr(), waddchstr(), waddchstr() and waddchnstr(), respectively, except that wmove() is called to move the cursor to the position specified by y, x before the string is added to the window.

# RETURN VALUES

The functions will return one of the following values:

OK
  The function completed successfully.
ERR
  An error occurred in the function.

# SEE ALSO

curses_addch(3), curses_addstr(3), curses_attributes(3), curses_cursor(3), curses_inch(3)

# STANDARDS

The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification.

# HISTORY

These functions first appeared in NetBSD 2.0.

May 21, 2003 | NetBSD 7.2