xref: /illumos-gate/usr/src/man/man3curses/curs_addwstr.3curses (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
CURS_ADDWSTR 3CURSES "June 18, 2021"
NAME
curs_addwstr, addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr, mvwaddwstr, mvwaddnwstr - add a string of wchar_t characters to a curses window and advance cursor
SYNOPSIS
cc [flag]... file... -lcurses [library]...

#include <curses.h>

int addwstr(wchar_t *wstr);

int addnwstr(wchar_t *wstr, int n);

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

int waddnwstr(WINDOW *win, wchar_t *wstr, int n);

int mvaddwstr(int y, int x, wchar_t *wstr);

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

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

int mvwaddnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);
DESCRIPTION
All of these routines write all the characters of the null-terminated wchar_t character string wstr on the given window. The effect is similar to calling waddwch(3CURSES) once for each wchar_t character in the string. The four routines with n as the last argument write at most n wchar_t characters. If n is negative, then the entire string will be added.
RETURN VALUE
All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO
curses (3CURSES), waddwch (3CURSES), attributes (7)
NOTES
The header file <curses.h> automatically includes the header files <stdio.h>, <nctrl.h> and <widec.h>.

Note that all of these routines except waddwstr() and waddnwstr() may be macros.