***************************************************************************
Copyright 2019-2023,2024 Thomas E. Dickey *
Copyright 2002-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_addwstr.3x,v 1.37 2024/04/20 19:18:18 tom Exp $
.\} .\} . .. \%addwstr, \%addnwstr, \%waddwstr, \%waddnwstr, \%mvaddwstr, \%mvaddnwstr, \%mvwaddwstr, \%mvwaddnwstr - add a wide-character string to a curses window and advance the cursor

#include <curses.h>

int addwstr(const wchar_t *wstr);
int mvaddwstr(int y, int x, const wchar_t *wstr);
int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr);
int waddwstr(WINDOW *win, const wchar_t *wstr);

int addnwstr(const wchar_t *wstr, int n);
int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);
int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);

waddwstr writes the characters of the (wide-null-terminated) wide-character string wstr to the window win . Its process is similar to constructing a cchar_t for each wchar_t in wstr , then calling \%wadd_wch(3X) with the resulting cchar_t . .bP Spacing and non-spacing characters in the string are processed one at a time, and .bP control characters are processed as in \%wadd_wch(3X).

waddnwstr writes at most n wide characters, or until a terminating wide null character occurs in wstr . If n is -1, waddnwstr writes the entire wide 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 \%wadd_wch(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 waddnwstr may be implemented as macros. X/Open Curses, Issue 4 describes these functions. \%curs_addstr(3X) describes comparable functions of the \%ncurses library in its non-wide-character configuration.

\%curses(3X), \%curs_add_wch(3X), \%curs_add_wchstr(3X)