***************************************************************************
Copyright 2019,2020 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.15 2020/10/17 23:12:22 tom Exp $
.. addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr, mvwaddwstr, mvwaddnwstr - add a string of wide characters to a curses window and advance cursor

#include <curses.h>

int addwstr(const wchar_t *wstr);

int addnwstr(const wchar_t *wstr, int n);

int waddwstr(WINDOW *win, const wchar_t *wstr);

int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);
int mvaddwstr(int y, int x, const wchar_t *wstr);

int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);

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

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

These functions write the characters of the (null-terminated) wchar_t character string wstr on the given window. It is similar to constructing a cchar_t for each wchar_t in the string, then calling wadd_wch for the resulting cchar_t.

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 wchar_t characters, 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 wadd_wch 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.

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