***************************************************************************
Copyright 2019-2023,2024 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.45 2024/04/20 19:18:18 tom Exp $
.\} .\} . .. \%addstr, \%addnstr, \%waddstr, \%waddnstr, \%mvaddstr, \%mvaddnstr, \%mvwaddstr, \%mvwaddnstr - add a string to a curses window and advance the cursor

#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.

X/Open Curses does not specify any error conditions. \%ncurses returns an error .bP if the window pointer is NULL , .bP if the string pointer is NULL , or .bP if an internal \%waddch(3X) call returns an error.

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. \%curs_addwstr(3X) describes comparable functions of the \%ncurses library in its wide-character configuration ( \%ncursesw ).

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