***************************************************************************
Copyright 2019,2020 Thomas E. Dickey *
Copyright 1998-2012,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_addstr.3x,v 1.23 2020/10/17 23:11:02 tom Exp $
.. addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr, mvwaddstr, mvwaddnstr - add a string of characters to a curses window and advance cursor

#include <curses.h>

int addstr(const char *str);

int addnstr(const char *str, int n);

int waddstr(WINDOW *win, const char *str);

int waddnstr(WINDOW *win, const char *str, int n);
int mvaddstr(int y, int x, const char *str);

int mvaddnstr(int y, int x, const char *str, int n);

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

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

These functions write the (null-terminated) character string str on the given window. It is similar to calling waddch once for each byte in the string.

The mv functions perform cursor movement once, before writing any characters. Thereafter, the cursor is advanced as a side-effect of writing to the window.

The four functions with n as the last argument write at most n bytes, or until a terminating null is reached. If n is -1, then the entire string will be added.

All functions return the integer ERR upon failure and OK on success.

X/Open does not define any error conditions. This implementation returns an error .bP if the window pointer is null or .bP if the string pointer is null or .bP if the corresponding calls to waddch return an error.

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. If an error is returned by the wmove, no characters are added to the window.

If an error is returned by waddch (e.g., because the window is not large enough, or an illegal byte sequence was detected) only part of the string may be added. Aside from that, there is a special case in waddch where an error may be returned after successfully writing a character to the lower-right corner of a window when scrollok is disabled.

All of these functions except waddnstr may be macros. These functions are described in the XSI Curses standard, Issue 4. curses(3X), curs_addch(3X).